USGS ScienceBase Tools


[Up] [Top]

Documentation for package ‘sbtools’ version 1.3.2

Help Pages

sbtools-package R interface to ScienceBase
as.sbitem ScienceBase item class
as.sbitem.default ScienceBase item class
authenticate_sb Authenticate to SB for subsequent calls
current_session Return current cached session
folder_create Create a folder
identifier_exists Check if identifier exists
initialize_sciencebase_session Initialize ScienceBase Session
is.sbitem ScienceBase item class
is_logged_in Check whether you're logged into a ScienceBase session
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_file_download Download files attached to item
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_list_files Get list of files attached to SB item
item_move Move item from one folder to another
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 Remove item from SB
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_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
sbitem ScienceBase item class
sbtools R interface to ScienceBase
sb_datatypes Query SB for all available datatypes
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