Skip to content

Commit

Permalink
docs: move files to inst/vign and remove rmarkdown dep fixes #31
Browse files Browse the repository at this point in the history
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
Show file tree
Hide file tree
Showing 12 changed files with 288 additions and 283 deletions.
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ README.Rmd
^cran-comments\.md$
inst/img/
.github

^\inst\vign
^codemeta\.json$
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ Imports:
phytools
Suggests:
testthat,
knitr,
rmarkdown
knitr
RoxygenNote: 6.0.1
X-schema.org-applicationCategory: Data Access
X-schema.org-keywords: phylogeny, tree, phylomatic, molecular, plants
Expand Down
File renamed without changes.
69 changes: 69 additions & 0 deletions inst/vign/brranching_vignette.Rmd
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)
202 changes: 202 additions & 0 deletions inst/vign/brranching_vignette.html

Large diffs are not rendered by default.

File renamed without changes.
Binary file added inst/vign/tools/img/unnamed-chunk-5-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added inst/vign/tools/img/unnamed-chunk-6-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 15 additions & 14 deletions vignettes/brranching_vignette.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,7 @@
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

Expand All @@ -25,40 +17,49 @@ Brranching is an interface to many different sources of phylogenetic data (curre

Stable CRAN version

```{r eval=FALSE}

```r
install.packages("brranching")
```

Or dev version

```{r eval=FALSE}

```r
install.packages("devtools")
devtools::install_github("ropensci/brranching")
```

```{r}

```r
library("brranching")
```

## Phylomatic

Query Phylomatic for a phylogenetic tree.

```{r}

```r
taxa <- c("Poa annua", "Phlox diffusa", "Helianthus annuus")
tree <- phylomatic(taxa=taxa, get = 'POST')
plot(tree, no.margin=TRUE)
```

![plot of chunk unnamed-chunk-5](tools/img/unnamed-chunk-5-1.png)

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}

```r
library("taxize")
spp <- names_list("species", 200)
out <- phylomatic(taxa = spp, get = "POST")
plot(out, show.tip.label = FALSE)
```

![plot of chunk unnamed-chunk-6](tools/img/unnamed-chunk-6-1.png)

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/brranching/issues).
Expand Down
266 changes: 0 additions & 266 deletions vignettes/brranching_vignette.html

This file was deleted.

Binary file removed vignettes/tools/img/unnamed-chunk-5-1.png
Binary file not shown.
Binary file removed vignettes/tools/img/unnamed-chunk-6-1.png
Binary file not shown.

0 comments on commit da1adca

Please sign in to comment.