search_family_id {SP2000}R Documentation

Search family IDs

Description

Search family IDs via family name, supports Latin and Chinese names.

Usage

search_family_id(query = NULL, start = 1, limit = 20, mc.cores = 2)

Arguments

query

character One and more queries,support Family name, or part of family name, supports Latin and Chinese names.

start

integer Record number to start at. If omitted, the results are returned from the first record (start=1). Use in combination with limit to page through results. Note that we do the paging internally for you, but you can manually set the start parameter.

limit

integer Number of records to return, the default value is 20.

mc.cores

The number of cores to use, i.e. at most how many child processes will be run simultaneously. The option is initialized from environment variable MC_CORES if set. Must be at least one, and parallelization requires at least two cores,see mclapply for details.

Details

Visit the website http://sp2000.org.cn/api/document for more details

Value

dataframe

Author(s)

Liuyong Ding ly_ding@126.com

Examples

## Not run: 
##Set your key
set_search_key("your apiKey",db = "sp2000")

##Search family IDs via family name
familyid <- search_family_id(query = "Anguillidae")

## End(Not run)

[Package SP2000 version 0.2.0 Index]