Package: sbtools 1.4.1

David Blodgett

sbtools: USGS ScienceBase Tools

Tools for interacting with U.S. Geological Survey ScienceBase <https://www.sciencebase.gov> interfaces. ScienceBase is a data cataloging and collaborative data management platform. Functions included for querying ScienceBase, and creating and fetching datasets.

Authors:David Blodgett [cre], Luke Winslow [aut], Scott Chamberlain [ctb], Alison Appling [ctb], Jordan Read [ctb]

sbtools_1.4.1.tar.gz
sbtools_1.4.1.zip(r-4.7)sbtools_1.4.1.zip(r-4.6)sbtools_1.4.1.zip(r-4.5)
sbtools_1.4.1.tgz(r-4.6-any)sbtools_1.4.1.tgz(r-4.5-any)
sbtools_1.4.1.tar.gz(r-4.7-any)sbtools_1.4.1.tar.gz(r-4.6-any)
sbtools_1.4.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
sbtools/json (API)

# Install 'sbtools' in R:

install.packages('sbtools', repos = c('https://doi-usgs.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/doi-usgs/sbtools/issues

Pkgdown/docs site:https://doi-usgs.github.io

On CRAN:

sciencebase usgs

8.59 score 25 stars 2 packages 158 scripts 369 downloads 52 exports 12 dependencies

Last updated from:f8fdce1a54. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	130
source / vignettes	OK	288
linux-release-x86_64	OK	131
macos-release-arm64	OK	68
macos-oldrel-arm64	OK	114
windows-devel	OK	79
windows-release	OK	85
windows-oldrel	OK	75
wasm-release	OK	117

Exports:as.sbitem authenticate_sb current_session folder_create get_cached_token get_username identifier_exists initialize_sciencebase_session is_logged_in is.sbitem item_append_files item_create item_exists item_file_download item_get item_get_fields item_get_parent item_list_children item_list_files item_move item_publish_cloud item_rename_files item_replace_files item_rm item_rm_files item_update item_update_identifier item_upload_cloud item_upload_create item_upsert query_item_identifier query_item_in_folder query_items query_sb query_sb_datatype query_sb_date query_sb_doi query_sb_spatial query_sb_text sb_datatypes sb_ping sbtools_GET sbtools_POST sbtools_PUT session_age session_details session_expired session_renew session_validate set_endpoint token_stache_path user_id

Dependencies:askpass cli curl filelock httr jsonlite keyring mime openssl R6 sys yaml

sbtools -- getting started

Rendered fromsbtools.Rmdusingknitr::rmarkdown

Last update: 2025-04-16
Started: 2023-12-19

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
R interface to ScienceBase	sbtools-package sbtools
Authenticate to SB for subsequent calls [DEPRECATED]	authenticate_sb
Return current cached session	current_session
Create a folder	folder_create
get cached sciencebase token	get_cached_token
Get or set ScienceBase username	get_username
Check if identifier exists	identifier_exists
Initialize ScienceBase Session	initialize_sciencebase_session
Check whether you're logged into a ScienceBase session	is_logged_in
Upload File to Item	item_append_files
Create a new SB item	item_create
check if identifier touple already exists on SB	item_exists
Download files attached to item	item_file_download
Retrieve SB item	item_get
Retrieve specific fields from an SB item	item_get_fields
Get an item's parent ID	item_get_parent
Return IDs for all child items	item_list_children
Get list of files attached to SB item	item_list_files
Move item from one folder to another	item_move
Publish file to public cloud S3 bucket	item_publish_cloud
Rename item attached files	item_rename_files
Replace files associated with an item	item_replace_files
Remove item from SB	item_rm
Remove files associated with an item	item_rm_files
Update a SB item with new metadata	item_update
Add custom identifier to an existing item	item_update_identifier
Upload File to Item Cloud Storage	item_upload_cloud
#' Upload file(s) and create a new item	item_upload_create
Upsert an SB item	item_upsert
Query SB for items based on custom identifier	query_item_identifier
Search within an SB folder	query_item_in_folder
Query SB for items using generic query parameters	query_items
Query SB for items using generic query parameters	query_sb
Query SB for specific data type	query_sb_datatype
Query SB for items within a date range	query_sb_date
Query SB for specific DOI (Digital Object Identifier)	query_sb_doi
Query SB based on spatial extent	query_sb_spatial
Query SB for items containing specific text	query_sb_text
Query SB for all available datatypes	sb_datatypes
Ping ScienceBase to see if it's available	sb_ping
ScienceBase item class	as.sbitem as.sbitem.default is.sbitem sbitem
Get session info (deprecated)	session_details
Checks current session and re-authenticates if necessary	session_renew
Validate sbtools session state	session_validate
Set SB endpoint	set_endpoint
Get or set token stache data directory	token_stache_path
Get your parent ID	user_id