Skip to content

Commit

Permalink
update README with resources
Browse files Browse the repository at this point in the history
  • Loading branch information
alkaZeltser committed Jul 26, 2024
1 parent 4a5e783 commit 6d8930a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
metadata.yaml
LICENSE.md
RCMD-CHECK.R
^doc$
^Meta$
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
*.Rproj*
.Rproj.user
inst/doc
/doc/
/Meta/
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ To install the latest development version from GitHub:
# install.packages("devtools")
devtools::install_github("uclahs-cds/package-ApplyPolygenicScore")
# To access vignettes, make sure to add the `build_vignettes` argument:
devtools::install_github("uclahs-cds/package-ApplyPolygenicScore", build_vignettes = TRUE)
```

## Getting Started
Expand Down Expand Up @@ -72,6 +77,19 @@ If you wish to apply a PGS to a cohort, we recommend that genotypes for the whol
For more step-by-step instructions, check out our vignettes.

## Resources
This package is in the process of being submitted to CRAN, where the manual and vignettes will be readily available. In the meantime, if you have installed the package from GitHub with `build_vignettes = TRUE`, you may view the vignette by running the following:

```
vignette('UserGuide', package = 'ApplyPolygenicScore')
```
Or by simply opening the rendered file that will be automatically written to the `doc` folder in your local package directory.

View function-specific documentation using `?`:

```
?apply.polygenic.score
```


## Getting Help
Looking for guidance or support with ApplyPolygenicScore? Check out our [Discussions](https://github.com/uclahs-cds/package-ApplyPolygenicScore/discussions) page.
Expand Down

0 comments on commit 6d8930a

Please sign in to comment.