Package: sbtools 1.3.2

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.3.2.tar.gz
sbtools_1.3.2.zip(r-4.5)sbtools_1.3.2.zip(r-4.4)sbtools_1.3.2.zip(r-4.3)
sbtools_1.3.2.tgz(r-4.4-any)sbtools_1.3.2.tgz(r-4.3-any)
sbtools_1.3.2.tar.gz(r-4.5-noble)sbtools_1.3.2.tar.gz(r-4.4-noble)
sbtools_1.3.2.tgz(r-4.4-emscripten)sbtools_1.3.2.tgz(r-4.3-emscripten)
sbtools.pdf |sbtools.html✨
sbtools/json (API)
NEWS

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

Peer review:

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

On CRAN:

sciencebaseusgs

8.33 score 21 stars 1 packages 122 scripts 520 downloads 52 exports 15 dependencies

Last updated 6 months agofrom:a54f89616e. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 25 2024
R-4.5-winOKOct 25 2024
R-4.5-linuxOKOct 25 2024
R-4.4-winOKOct 25 2024
R-4.4-macOKOct 25 2024
R-4.3-winOKOct 25 2024
R-4.3-macOKOct 25 2024

Exports:as.sbitemauthenticate_sbcurrent_sessionfolder_createidentifier_existsinitialize_sciencebase_sessionis_logged_inis.sbitemitem_append_filesitem_createitem_existsitem_file_downloaditem_getitem_get_fieldsitem_get_parentitem_list_childrenitem_list_filesitem_moveitem_publish_clouditem_rename_filesitem_replace_filesitem_rmitem_rm_filesitem_updateitem_update_identifieritem_upload_clouditem_upload_createitem_upsertitems_createitems_updateitems_upsertquery_item_identifierquery_item_in_folderquery_itemsquery_sbquery_sb_datatypequery_sb_datequery_sb_doiquery_sb_spatialquery_sb_textsb_datatypessb_pingsbtools_GETsbtools_POSTsbtools_PUTsession_agesession_detailssession_expiredsession_renewsession_validateset_endpointuser_id

Dependencies:askpassassertthatclicurlfilelockhttrjsonlitekeyringmimeopensslR6rappdirssodiumsysyaml

sbtools -- getting started

[email protected]

Rendered fromsbtools.Rmdusingknitr::rmarkdownon Oct 25 2024.

Last update: 2023-12-26
Started: 2023-12-19

Readme and manuals

Help Manual

Help pageTopics
R interface to ScienceBasesbtools-package sbtools
Authenticate to SB for subsequent callsauthenticate_sb
Return current cached sessioncurrent_session
Create a folderfolder_create
Check if identifier existsidentifier_exists
Initialize ScienceBase Sessioninitialize_sciencebase_session
Check whether you're logged into a ScienceBase sessionis_logged_in
Upload File to Itemitem_append_files
Create a new SB itemitem_create
check if identifier touple already exists on SBitem_exists
Download files attached to itemitem_file_download
Retrieve SB itemitem_get
Retrieve specific fields from an SB itemitem_get_fields
Get an item's parent IDitem_get_parent
Return IDs for all child itemsitem_list_children
Get list of files attached to SB itemitem_list_files
Move item from one folder to anotheritem_move
Publish file to public cloud S3 bucketitem_publish_cloud
Rename item attached filesitem_rename_files
Replace files associated with an itemitem_replace_files
Remove item from SBitem_rm
Remove files associated with an itemitem_rm_files
Update a SB item with new metadataitem_update
Add custom identifier to an existing itemitem_update_identifier
Upload File to Item Cloud Storageitem_upload_cloud
#' Upload file(s) and create a new itemitem_upload_create
Upsert an SB itemitem_upsert
Create many new SB itemsitems_create
Update many SB items with new metadataitems_update
Upsert many SB itemsitems_upsert
Query SB for items based on custom identifierquery_item_identifier
Search within an SB folderquery_item_in_folder
Query SB for items using generic query parametersquery_items
Query SB for items using generic query parametersquery_sb
Query SB for specific data typequery_sb_datatype
Query SB for items within a date rangequery_sb_date
Query SB for specific DOI (Digital Object Identifier)query_sb_doi
Query SB based on spatial extentquery_sb_spatial
Query SB for items containing specific textquery_sb_text
Query SB for all available datatypessb_datatypes
Ping ScienceBase to see if it's availablesb_ping
ScienceBase item classas.sbitem as.sbitem.default is.sbitem sbitem
Get session info (deprecated)session_details
Checks current session and re-authenticates if necessarysession_renew
Validate sbtools session statesession_validate
Set SB endpointset_endpoint
Get your parent IDuser_id