Skip to content

Commit

Permalink
dontrun some long running egs, update readme, bump to v0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Jan 13, 2017
1 parent 1baca4c commit 667da7b
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 8 deletions.
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description: Client for World Register of Marine Species
common names, searching using external identifiers, fetching
synonyms, as well as fetching taxonomic children and
taxonomic classification.
Version: 0.0.8.9340
Version: 0.1.0
Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"),
email = "[email protected]"))
License: MIT + file LICENSE
Expand All @@ -26,4 +26,3 @@ Suggests:
testthat,
covr
RoxygenNote: 5.0.1
Remotes: ropensci/crul
3 changes: 3 additions & 0 deletions R/wm_records_common.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
#' @examples
#' wm_records_common(name = 'dolphin')
#' wm_records_common(name = 'clam')
#'
#' \dontrun{
#' wm_records_common(name = 'dolphin', fuzzy = TRUE)
#' wm_records_common(name = 'clam', fuzzy = TRUE, offset = 5)
#' }
wm_records_common <- function(name, fuzzy = FALSE, offset = 1,
...) {
assert(name, "character")
Expand Down
5 changes: 3 additions & 2 deletions R/wm_records_taxamatch.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
#' the TAXAMATCH fuzzy matching algorithm
#'
#' @export
#' @param name (character) start date. required.
#' @param name (character) taxon name. required.
#' @param marine_only (logical) marine only or not. default: \code{TRUE}
#' @template curl
#' @examples
#' @examples \dontrun{
#' wm_records_taxamatch(name = 'Platanista gangetica')
#' wm_records_taxamatch(name = c('Platanista gangetica', 'Coryphaena'))
#' }
wm_records_taxamatch <- function(name, marine_only = TRUE, ...) {
assert(name, "character")
assert(marine_only, "logical")
Expand Down
8 changes: 8 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ knitr::opts_chunk$set(

## Installation

More stable CRAN version

```{r eval=FALSE}
install.packages("worrms")
```

Development version

```{r eval=FALSE}
devtools::install_github("ropensci/worrms")
```
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ worrms

## Installation

More stable CRAN version


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

Development version


```r
devtools::install_github("ropensci/worrms")
Expand Down Expand Up @@ -42,9 +51,9 @@ wm_records_date('2016-12-23T05:59:45+00:00')
#> 5 894296 http://www.marinespecies.org/aphia.php?p=taxdetails&id=894296
#> 6 894299 http://www.marinespecies.org/aphia.php?p=taxdetails&id=894299
#> 7 894303 http://www.marinespecies.org/aphia.php?p=taxdetails&id=894303
#> 8 897486 http://www.marinespecies.org/aphia.php?p=taxdetails&id=897486
#> 9 901957 http://www.marinespecies.org/aphia.php?p=taxdetails&id=901957
#> 10 899919 http://www.marinespecies.org/aphia.php?p=taxdetails&id=899919
#> 8 906769 http://www.marinespecies.org/aphia.php?p=taxdetails&id=906769
#> 9 909454 http://www.marinespecies.org/aphia.php?p=taxdetails&id=909454
#> 10 915236 http://www.marinespecies.org/aphia.php?p=taxdetails&id=915236
#> # ... with 40 more rows, and 23 more variables: scientificname <chr>,
#> # authority <chr>, status <chr>, unacceptreason <lgl>, rank <chr>,
#> # valid_AphiaID <int>, valid_name <chr>, valid_authority <chr>,
Expand Down
1 change: 1 addition & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* local OS X install, R 3.3.2
* ubuntu 12.04 (on travis-ci), R 3.3.2
* win-builder (devel and release)
* R-hub (Windows R-devel, Ubuntu R-release, Fedora R-devel)

## R CMD check results

Expand Down
3 changes: 3 additions & 0 deletions man/wm_records_common.Rd

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

4 changes: 3 additions & 1 deletion man/wm_records_taxamatch.Rd

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

0 comments on commit 667da7b

Please sign in to comment.