Usage
ncbi_children(name = NULL, id = NULL, start = 0, max_return = 1000,
ancestor = NULL, out_type = c("summary", "uid"), ambiguous = FALSE)
Arguments
name
(character
) The string to search for. Only exact matches found the name given
will be returned. Not compatible with id
.
id
(character
) The uid to search for. Not compatible with name
.
start
The first record to return. If omitted, the results are returned from the first
record (start=0).
max_return
(numeric; length=1
) The maximum number of children to return.
ancestor
(character
) The ancestor of the taxon being searched for. This is useful
if there could be more than one taxon with the same name. Has no effect if id
is used.
out_type
(character) Currently either "summary"
or "uid"
:
[object Object],[object Object]
ambiguous
logical; length 1
If FALSE
, children taxa with words like
"unclassified", "unknown", "uncultured", or "sp." are removed from the output.
NOTE: This option only applies when out_type = "summary"
.