sbtools (version 1.2.0)

item_get_fields: Retrieve specific fields from an SB item

Description

Retrieve specific fields from an SB item

Usage

item_get_fields(sb_id, fields, ..., drop = TRUE, session = current_session())

Value

List serialization of chosen metadata for an SB item

Arguments

sb_id

An sbitem object or a character ScienceBase ID corresponding to the item

fields

a vector of fields

...

Additional parameters are passed on to GET, POST, HEAD, PUT, or DELETE

drop

logical. If only one field is selected, should the list format be dropped?

session

Session object from authenticate_sb. Defaults to anonymous or last authenticated session

Examples

# \donttest{
# Get certain fields from an item
item_get_fields("4f4e4b24e4b07f02db6aea14", c('title', 'citation', 'contacts'))

#' # If only 1 field selection, do or don't drop list format
item_get_fields("4f4e4b24e4b07f02db6aea14", 'title')
item_get_fields("4f4e4b24e4b07f02db6aea14", 'title', drop = FALSE)
# }