README.md 1 KB
Newer Older
Ashley Stewart's avatar
Ashley Stewart committed
1
2
3
# Installation
To install this package directly from git, you will first need the devtools package if not already installed:
```
Jason Rigby's avatar
Jason Rigby committed
4
install.packages("devtools")
Ashley Stewart's avatar
Ashley Stewart committed
5
```
6
Please ensure all r packages required are up to date when installing the uds package, during installation of the uds package you will be asked if you wish to update any of the required packages. 
Ashley Stewart's avatar
Ashley Stewart committed
7

8
9

The uds package itself can be installed using the following command:
Ashley Stewart's avatar
Ashley Stewart committed
10
11
12
13
```
devtools::install_git("https://gitlab.erc.monash.edu.au/aspree/uds-r-package.git")
```

Ashley Stewart's avatar
Ashley Stewart committed
14
You will then need to load the package. 
Ashley Stewart's avatar
Ashley Stewart committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
library("uds")

The api url will need to be entered. 
This url can then be used as a part of the UDSConnection function. 


Here's an example using the UDS library to pull data from a Test Project
```
library(uds)
url <- [paste url to api here]

con <- UDSConnection(url, allow_insecure=TRUE)
test <- UDSDataExport(con, "Test Project")

```
30
31
When the USDConnection function is run you will be asked for authentication details to verify you have access to the api.