taxize (version 0.9.91)

taxon_state: Keep track of queries in get_* functions

Description

This object lives inside each get_* function call, maintaining results as they are accumulated.

Arguments

class

(character) a class name (e.g., "gbif")

names

(character) one or more taxon names

Details

Methods

add(query, result)

add a record with it's result; duplicates allowed - query (character), a taxon name - result (list) a named list

get(query)

get all records matching 'query' - query (character), a taxon name

remove(query)

remove's all records matching 'query' - query (character), a taxon name

purge()

removes all records

taxa_remaining()

get remaining taxa

taxa_completed()

get remaining taxa

count (active binding)

count number of records

exit (active binding)

record date/time function exited

Examples

# NOT RUN {
ts <- taxon_state$new()
taxon_last()
ts
res <- list(
  id = 123456,
  att = "found",
  multiple = FALSE,
  direct = FALSE,
  class = "tsn"
)
ts$add(query = "Quercus robur", result = res)
ts
ts$get(query = "Quercus robur")
ts$count
ts$remove(query = "Quercus robur")
ts
ts$count

res2 <- list(
  id = 3430834535,
  att = "found",
  multiple = FALSE,
  direct = FALSE,
  class = "gbifid"
)
ts$add(query = "Poa annua", result = res2)
res3 <- list(
  id = 1223424,
  att = "found",
  multiple = FALSE,
  direct = FALSE,
  class = "uid"
)
ts$add(query = "Puma concolor", result = res3)
ts
ts$count
ts$get("Puma concolor")
ts$get()

# cleanup
ts$purge()
ts$count
# }

Run the code above in your browser using DataCamp Workspace