Skip to content

Commit

Permalink
Rerender docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sherrillmix committed Jun 23, 2022
1 parent 8c752f1 commit 4595253
Show file tree
Hide file tree
Showing 22 changed files with 58 additions and 26 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Authors@R: c(person("Scott", "Sherrill-Mix", role = c("aut", "cre"),
BugReports: https://github.com/sherrillmix/taxonomizr/issues
Description: Functions for assigning taxonomy to NCBI accession numbers and taxon IDs based on NCBI's accession2taxid and taxdump files. This package allows the user to download NCBI data dumps and create a local database for fast and local taxonomic assignment.
Version: 0.9.2
Date: 2022-06-22
Date: 2022-06-23
Suggests:
testthat,
knitr,
Expand Down
17 changes: 15 additions & 2 deletions docs/articles/usage.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 16 additions & 3 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ pkgdown: 2.0.3
pkgdown_sha: ~
articles:
usage: usage.html
last_built: 2022-06-22T15:26Z
last_built: 2022-06-23T14:10Z

2 changes: 1 addition & 1 deletion docs/reference/accessionToTaxa.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/getAccession2taxid.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/getNamesAndNodes.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/read.accession2taxid.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/read.names.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/read.names.sql.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/read.nodes.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/read.nodes.sql.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/streamingRead.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/accessionToTaxa.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/getAccession2taxid.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/getNamesAndNodes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read.accession2taxid.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read.names.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read.names.sql.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read.nodes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read.nodes.sql.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions vignettes/usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,12 @@ Note that taxa may be the most specific taxon for a given taxa in the taxonomy m


## Changelog
### v0.9.2
* Allow factors as input to accessionToTaxa
* Document sqlite pragmas for `read.accession2taxid`
* Inherit ... argument documentation for `prepareDatabase`
* Catch input/output error while processing large files
* Update various user-facing links from ftp to https for easier access

### v0.8.4
* Add quote option to `makeNewick`
Expand Down Expand Up @@ -511,7 +517,7 @@ In order to avoid constant internet access and slow APIs, the first step in usin
**Note:** It is not necessary to manually check for the presence of these files since the functions automatically check to see if their output is present and if so skip downloading/processing. Delete the local files if you would like to redownload or reprocess them.

### Download names and nodes
First, download the necessary names and nodes files from [NCBI](ftp://ftp.ncbi.nih.gov/pub/taxonomy/):
First, download the necessary names and nodes files from [NCBI](https://ftp.ncbi.nih.gov/pub/taxonomy/):
```{r,eval=FALSE}
getNamesAndNodes()
```
Expand All @@ -522,7 +528,7 @@ getNamesAndNodes()

### Download accession to taxa files

Then download accession to taxa id conversion files from [NCBI](ftp://ftp.ncbi.nih.gov/pub/taxonomy/accession2taxid/). **Note:** this is a pretty _big_ download (several gigabytes):
Then download accession to taxa id conversion files from [NCBI](https://ftp.ncbi.nih.gov/pub/taxonomy/accession2taxid/). **Note:** this is a pretty _big_ download (several gigabytes):
```{r,eval=FALSE}
#this is a big download
getAccession2taxid()
Expand Down

0 comments on commit 4595253

Please sign in to comment.