-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.Rmd
72 lines (49 loc) · 2.43 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
warning = FALSE,
message = FALSE,
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![R-CMD-check](https://github.com/ropensci/rvertnet/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/rvertnet/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/ropensci/rvertnet/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/rvertnet?branch=master) [![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/rvertnet)](https://github.com/r-hub/cranlogs.app) [![cran version](https://www.r-pkg.org/badges/version/rvertnet)](https://cran.r-project.org/package=rvertnet)
<!-- badges: end -->
# rvertnet
`rvertnet` is a client for interacting with [VertNet.org](http://vertnet.org/).
VertNet.org API docs: <https://github.com/VertNet/webapp/wiki/The-API-search-function>
## Installation
Stable CRAN version
```{r eval=FALSE}
install.packages("rvertnet")
```
Development version from GitHub
```{r eval=FALSE}
remotes::install_github("ropensci/rvertnet", build_vignettes = TRUE)
```
## [Get started](https://docs.ropensci.org/rvertnet/articles/rvertnet.html)
[View vignette on ropensci website](https://docs.ropensci.org/rvertnet/articles/rvertnet.html)
Or, view vignette locally in your web browser
```{r eval=FALSE}
browseVignettes("rvertnet")
```
Or, view vignette in the Rstudio help pane
```{r eval=FALSE}
vignette("rvertnet")
```
## Contributors
- Dave Slager [\@slager](https://github.com/slager)
- Scott Chamberlain [\@sckott](https://github.com/sckott)
- Chris Ray [\@Pika8tona](https://github.com/Pika8tona)
- Vijay Barve [\@vijaybarve](https://github.com/vijaybarve)
## Meta
- Please [report any issues or bugs](https://github.com/ropensci/rvertnet/issues).
- License: MIT
- Get citation information for `rvertnet` in R doing `citation(package = 'rvertnet')`
- Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.