Commit 560f8734 authored by Jason Rigby's avatar Jason Rigby
Browse files

update documentation

parent ef2f5b23
......@@ -6,12 +6,20 @@ install.packages(c("devtools", "getPass"))
Then, the ASPREE package itself can be installed using the following command:
```
username <- "your_monash_username"
devtools::install_git("https://gitlab.erc.monash.edu.au/aspree/aspree-r-package.git",
credentials = git2r::cred_user_pass(readline(prompt="USERNAME: "),
getPass::getPass()))
credentials = git2r::cred_user_pass(username, getPass::getPass()))
```
You will be prompted for your Monash GitLab credentials before installation proceeds.
Here's an example using the ASPREE library to retrieve ASPREE XT consent status:
```
library(aspree)
library(dplyr)
aspreeConsent <- aspreeDb("ASPREE Data Snapshot") %>% getXTConsent()
```
# Development
Recommended reading: [the devtools cheatsheet](https://www.rstudio.com/wp-content/uploads/2015/03/devtools-cheatsheet.pdf)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment