File: rl_synonyms.R

package info (click to toggle)
r-cran-rredlist 0.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,968 kB
  • sloc: sh: 9; makefile: 5
file content (24 lines) | stat: -rw-r--r-- 695 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#' Get species synonym information by taxonomic name
#'
#' @export
#' @param name (character) Binomial taxonomic name
#' @template all
#' @template info
#' @examples \dontrun{
#' rl_synonyms('Loxodonta africana')
#' rl_synonyms('Loxodonta africana', parse = FALSE)
#' rl_synonyms_('Loxodonta africana')
#' }
rl_synonyms <- function(name = NULL, key = NULL, parse = TRUE, ...) {
  assert_is(parse, 'logical')
  rl_parse(rl_synonyms_(name, key, ...), parse)
}

#' @export
#' @rdname rl_synonyms
rl_synonyms_ <- function(name = NULL, key = NULL, ...) {
  assert_is(key, 'character')
  assert_is(name, 'character')
  assert_n(name, 1)
  rr_GET(file.path("species/synonym", space(name)), key, ...)
}