-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: move files to inst/vign and remove rmarkdown dep fixes #31
added inst/vign to buildignore and move .md output in vignette (changed to .Rmd) to speed up build.
- Loading branch information
Tim
committed
Nov 17, 2018
1 parent
4fbd162
commit da1adca
Showing
12 changed files
with
288 additions
and
283 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,5 +8,5 @@ README.Rmd | |
^cran-comments\.md$ | ||
inst/img/ | ||
.github | ||
|
||
^\inst\vign | ||
^codemeta\.json$ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
<!-- | ||
%\VignetteEngine{knitr::knitr} | ||
%\VignetteIndexEntry{brranching vignette} | ||
%\VignetteEncoding{UTF-8} | ||
--> | ||
|
||
brranching - an interface to phylogenetic data | ||
====== | ||
|
||
```{r echo=FALSE} | ||
knitr::opts_chunk$set( | ||
comment = "#>", | ||
collapse = TRUE, | ||
warning = FALSE, | ||
message = FALSE, | ||
fig.path="tools/img/" | ||
) | ||
``` | ||
|
||
## Description | ||
|
||
Brranching is an interface to many different sources of phylogenetic data (currently only from [Phylomatic](http://phylodiversity.net/phylomatic/), but more sources to come). It is used to query for phylogenetic data using taxonomic names and can be used to visualise the evolutionary history and relationships among individuals or groups of organisms. | ||
|
||
## Installation | ||
|
||
Stable CRAN version | ||
|
||
```{r eval=FALSE} | ||
install.packages("brranching") | ||
``` | ||
|
||
Or dev version | ||
|
||
```{r eval=FALSE} | ||
install.packages("devtools") | ||
devtools::install_github("ropensci/brranching") | ||
``` | ||
|
||
```{r} | ||
library("brranching") | ||
``` | ||
|
||
## Phylomatic | ||
|
||
Query Phylomatic for a phylogenetic tree. | ||
|
||
```{r} | ||
taxa <- c("Poa annua", "Phlox diffusa", "Helianthus annuus") | ||
tree <- phylomatic(taxa=taxa, get = 'POST') | ||
plot(tree, no.margin=TRUE) | ||
``` | ||
|
||
You can pass in up to about 5000 names. We can use [`taxize`](https://github.com/ropensci/taxize/) to get a random set of plant species names. | ||
|
||
```{r} | ||
library("taxize") | ||
spp <- names_list("species", 200) | ||
out <- phylomatic(taxa = spp, get = "POST") | ||
plot(out, show.tip.label = FALSE) | ||
``` | ||
|
||
## Meta | ||
|
||
* Please [report any issues or bugs](https://github.com/ropensci/brranching/issues). | ||
* License: MIT | ||
* Get citation information for `brranching` in R doing `citation(package = 'brranching')` | ||
* Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
||
[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org) |
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.