Skip to content

Commit

Permalink
make the repo ready for the release of v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Cazelles committed Nov 16, 2018
1 parent e675f6b commit 7c38a84
Show file tree
Hide file tree
Showing 40 changed files with 166 additions and 248 deletions.
2 changes: 0 additions & 2 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
^CONDUCT.md
^record*
^\.httr-oauth
^inst/assets/
^inst/tmp/
^\.github/
^\.Renviron
^paper.bib
Expand Down
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@

* Fork this repo to your Github account
* Clone your version on your account down to your machine from your account, e.g,. `git clone https://github.com/<yourgithubusername>/rcites.git`
* Make sure to track progress upstream (i.e., on our version of `rcites` at `ibartomeus/rcites`) by doing `git remote add upstream https://github.com/ibartomeus/rcites.git`. Before making changes make sure to pull changes in from upstream by doing either `git fetch upstream` then merge later or `git pull upstream` to fetch and merge in one step
* Make sure to track progress upstream (i.e., on our version of `rcites` at `ropensci/rcites`) by doing `git remote add upstream https://github.com/ropensci/rcites.git`. Before making changes make sure to pull changes in from upstream by doing either `git fetch upstream` then merge later or `git pull upstream` to fetch and merge in one step
* Make your changes (bonus points for making changes on a new feature branch)
* Please do write a test(s) for your changes if they affect code and not just docs (see Tests below)
* Push up to your account
* Submit a pull request to home base at `ibartomeus/rcites`
* Submit a pull request to home base at `ropensci/rcites`

### Tests

Expand Down
6 changes: 5 additions & 1 deletion .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!-- If this issue relates to usage of the package, whether a question, bug or similar, along with your query, please paste your devtools::session_info() or sessionInfo() into the code block below. If not, delete all this and proceed :) -->
<!--
If this issue relates to usage of the package, whether a question, bug or similar,
along with your query, please paste your devtools::session_info() or sessionInfo()
into the code block below. If not, delete all this and proceed :)
-->

<details> <summary><strong>Session Info</strong></summary>

Expand Down
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ matrix:
- os: linux
r: release
env: NOT_CRAN=true
- os: osx
r: release
env: NOT_CRAN=true
- os: linux
r: devel
env: NOT_CRAN=false
Expand Down
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: rcites
Type: Package
Title: R Interface to the Species+ Database
Version: 0.1.0.9000
Version: 0.1.0
Authors@R: c(person("Jonas", "Geschke", role = c("aut"), email = "jonas.e.geschke@gmail.com", comment = c(ORCID = "0000-0002-5654-9313")),
person("Kevin", "Cazelles", role = c("aut", "cre"), email = "kevin.cazelles@gmail.com", comment = c(ORCID = "0000-0001-6619-9874")),
person("Ignasi", "Bartomeus", role = c("aut"), comment = c(ORCID = "0000-0001-7893-4389")),
Expand All @@ -11,8 +11,8 @@ Authors@R: c(person("Jonas", "Geschke", role = c("aut"), email = "jonas.e.geschk
person("Noam", "Ross", role = c("rev")),
person("Margaret", "Siple", role = c("rev")))
Description: A programmatic interface to the Species+ <https://speciesplus.net/> database via the Species+/CITES Checklist API <https://api.speciesplus.net/>.
URL: https://ibartomeus.github.io/rcites/, https://github.com/ibartomeus/rcites
BugReports: https://github.com/ibartomeus/rcites/issues
URL: https://ropensci.github.io/rcites/, https://github.com/ropensci/rcites
BugReports: https://github.com/ropensci/rcites/issues
License: MIT + file LICENSE
Depends:
R (>= 3.1.0)
Expand Down
6 changes: 4 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# rcites 0.1.1.9000
# rcites 1.0.0.9000

# rcites 1.0.0

- new features:

- `spp_taxonconcept()` now includes an auto-pagination that allows to retrieve
all entries for queries that have more than 500 results;
- `spp_taxonconcept()`, `spp_eu_legislation()`, `spp_cites_legislation()` and `spp_references()` now supports vectors as `taxon_id` argument which allows
bulk analysis.
bulk analysis.
- Functions `spp_*` now returns S3 objects:
- `spp_taxonconcept()` returns an object of class `spp_taxon`;
- `spp_cites_legislation()` returns an object of class `spp_cites_leg` or `spp_cites_leg_multi`;
Expand Down
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@
### Current Status

[![Build status](https://travis-ci.org/ropensci/rcites.svg?branch=master)](https://travis-ci.org/ropensci/rcites)
[![Build status](https://ci.appveyor.com/api/projects/status/bsd3c7mv12xv959j/branch/master?svg=true)](https://ci.appveyor.com/project/KevCaz/rcites/branch/master)
[![Build status](https://ci.appveyor.com/api/projects/status/kgimo4v7rvtpkp5e?svg=true)](https://ci.appveyor.com/project/KevCaz/rcites-mo3vb)
[![codecov](https://codecov.io/gh/ropensci/rcites/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/rcites)
[![Coverage Status](https://coveralls.io/repos/github/ropensci/rcites/badge.svg?branch=master)](https://coveralls.io/github/ropensci/rcites?branch=master)
[![ROpenSci status](https://badges.ropensci.org/244_status.svg)](https://github.com/ropensci/onboarding/issues/244)
[![CRAN status](https://www.r-pkg.org/badges/version/rcites)](https://www.r-pkg.org/badges/version/rcites)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/rcites)](https://cran.r-project.org/package=rcites)


# rcites

An R package to access information from the [Speciesplus](https://speciesplus.net/) database via the [Species+/CITES Checklist API](https://api.speciesplus.net/documentation/v1.html). The package is available for download from [CRAN](https://cran.r-project.org/package=rcites) (stable version) and [Github](https://github.com/ibartomeus/rcites) (development version).
An R package to access information from the [Speciesplus](https://speciesplus.net/) database via the [Species+/CITES Checklist API](https://api.speciesplus.net/documentation/v1.html). The package is available for download from [CRAN](https://cran.r-project.org/package=rcites) (stable version) and [Github](https://github.com/ropensci/rcites) (development version).

Please see the [release paper](link to come) for background information about the Convention on International Trade in Endangered Species of Wild Fauna and Flora ([CITES](https://cites.org)), the Species+ database and basic information about the aim of the package.

Expand All @@ -30,7 +29,7 @@ library("rcites")
The development version can be installed via the `devtools` package:

```R
devtools::install_github("ibartomeus/rcites")
devtools::install_github("ropensci/rcites")
library("rcites")
```

Expand All @@ -39,12 +38,12 @@ library("rcites")

To set up a connection to the CITES Species+ database, a personal authentication
token is required. Please see the vignette for details how to get a token and
how to set the token for package use: [Get started with rcites](https://ibartomeus.github.io/rcites/articles/get_started.html)
how to set the token for package use: [Get started with rcites](https://ropensci.github.io/rcites/articles/get_started.html)

Additional information about specific use examples are provided for the
[African bush elephant (*Loxodonta africana*)](https://ibartomeus.github.io/rcites/articles/elephant.html).
[African bush elephant (*Loxodonta africana*)](https://ropensci.github.io/rcites/articles/elephant.html).
The package usage for querying multiple species is described in another
vignette entitled ['Bulk analysis with rcites'](https://ibartomeus.github.io/rcites/articles/bulk_analysis.html).
vignette entitled ['Bulk analysis with rcites'](https://ropensci.github.io/rcites/articles/bulk_analysis.html).


### Key features
Expand All @@ -69,13 +68,13 @@ The package functions have three different prefixes:

### Citation information

When citing, please refer to both the [package citation](https://ibartomeus.github.io/rcites/authors.html).
When citing, please refer to both the [package citation](https://ropensci.github.io/rcites/authors.html).
<!-- and the [release paper](link to come). -->


## Contributors

- [Main contributors](https://github.com/ibartomeus/rcites/graphs/contributors)
- [Main contributors](https://github.com/ropensci/rcites/graphs/contributors)

- Reviewers of the package:
- [Noam Ross](https://github.com/noamross)
Expand Down
2 changes: 2 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ authors:
href: https://kevcaz.github.io/
Ignasi Bartomeus:
href: https://bartomeuslab.com/
Jonas Geschke:
href: https://www.linkedin.com/in/jonasgeschke/?originalSubdomain=de
6 changes: 3 additions & 3 deletions docs/CONDUCT.html

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

10 changes: 5 additions & 5 deletions docs/CONTRIBUTING.html

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

6 changes: 3 additions & 3 deletions docs/LICENSE-text.html

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

8 changes: 4 additions & 4 deletions docs/articles/bulk_analysis.html

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

10 changes: 5 additions & 5 deletions docs/articles/elephant.html

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

Loading

0 comments on commit 7c38a84

Please sign in to comment.