rt_status_search: Search statuses based on a list of criteria

View source: R/rt_status_search.R

rt_status_searchR Documentation

Search statuses based on a list of criteria

Description

Search statuses based on a list of criteria

Usage

rt_status_search(
  id = NULL,
  opgroup_id = NULL,
  location_id = NULL,
  latitude = NULL,
  longitude = NULL,
  page = 1,
  size = 2000,
  detail = FALSE
)

Arguments

id

integer(1) [required]
an integer giving the id of the taxon in TAXREF (also called cdNom)

opgroup_id

integer(1) [required]
identifier of the operational group (see the list of operational groups rt_operational_groups())

location_id

NULL or character(1) [default = NULL]
a string identifying a location

latitude

NULL or numeric(1) [default = NULL]
a latitude value

longitude

NULL or numeric(1) [default = NULL]
a longitude value

page

integer(1) [default = 1]
The page number returned

size

integer(1) [default = 2000]
The number of lines returned per page (maximum = 2000)

detail

logical(1) [default = FALSE]
Should the table be a long table detailing all the statuses or a compact table?

See Also

list of operational groups rt_operational_groups()

Examples

## Not run: 
rt_status_search(id = 443800, detail = FALSE)
rt_status_search(id = 443800, detail = TRUE)

## End(Not run)


Rekyt/rtaxref documentation built on June 18, 2022, 1:02 p.m.