Skip to content

Commit

Permalink
Add note about building vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
mooreryan committed Aug 29, 2023
1 parent 477270c commit 5618137
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ remotes::install_github("adw96/DivNet")
library(DivNet)
```

### Building Vignettes

By default, `remotes::install_github` will not build the included vignettes. If you would like to view the vignettes locally, install the packages using the following commands:

```r
remotes::install_github("adw96/breakaway", build_vignettes = TRUE)
remotes::install_github("adw96/DivNet", build_vignettes = TRUE)
```

## Basic Usage

Let’s analyse the Lee *et al.* dataset using DivNet. We could analyse at the ASV level, but to keep things simple let’s analyse the phylum level diversity.
Expand Down

0 comments on commit 5618137

Please sign in to comment.