Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about building vignettes #138

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Add note about building vignettes #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
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
Loading