Function reference • sbtools

Basics

sbtools-package sbtools: R interface to ScienceBase

authenticate_sb(): Authenticate to SB for subsequent calls

current_session(): Return current cached session

initialize_sciencebase_session(): Initialize ScienceBase Session

sb_ping(): Ping ScienceBase to see if it's available

session_details(): Get session info (deprecated)

session_renew(): Checks current session and re-authenticates if necessary

session_validate(): Validate sbtools session state

set_endpoint(): Set SB endpoint

user_id(): Get your parent ID

is_logged_in(): Check whether you're logged into a ScienceBase session

Item Operations

as.sbitem() is.sbitem(): ScienceBase item class

folder_create(): Create a folder

identifier_exists(): Check if identifier exists

items_create(): Create many new SB items

items_update(): Update many SB items with new metadata

items_upsert(): Upsert many SB items

item_append_files(): Upload File to Item

item_create(): Create a new SB item

item_exists(): check if identifier touple already exists on SB

item_get(): Retrieve SB item

item_get_fields(): Retrieve specific fields from an SB item

item_get_parent(): Get an item's parent ID

item_list_children(): Return IDs for all child items

item_move(): Move item from one folder to another

item_rm(): Remove item from SB

File Operations

item_file_download(): Download files attached to item

item_list_files(): Get list of files attached to SB item

item_publish_cloud(): Publish file to public cloud S3 bucket

item_rename_files(): Rename item attached files

item_replace_files(): Replace files associated with an item

item_rm_files(): Remove files associated with an item

item_update(): Update a SB item with new metadata

item_update_identifier(): Add custom identifier to an existing item

item_upload_cloud(): Upload File to Item Cloud Storage

item_upload_create(): #' Upload file(s) and create a new item

item_upsert(): Upsert an SB item

Query Functions

query_items(): Query SB for items using generic query parameters

query_item_identifier(): Query SB for items based on custom identifier

query_item_in_folder(): Search within an SB folder

query_sb(): Query SB for items using generic query parameters

query_sb_datatype(): Query SB for specific data type

query_sb_date(): Query SB for items within a date range

query_sb_doi(): Query SB for specific DOI (Digital Object Identifier)

query_sb_spatial(): Query SB based on spatial extent

query_sb_text(): Query SB for items containing specific text

sb_datatypes(): Query SB for all available datatypes