| Title: | USGS ScienceBase Tools |
|---|---|
| Description: | 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] |
| Maintainer: | David Blodgett <[email protected]> |
| License: | CC0 |
| Version: | 1.3.2 |
| Built: | 2024-10-25 05:02:22 UTC |
| Source: | https://github.com/doi-usgs/sbtools |
This package provides a rich interface to USGS's ScienceBase https://www.sciencebase.gov/ - a data cataloging and collaborative data management platform. For further information, see the sbtools manuscript here.
Functions are inluded for searching for data, retrieving, creating, and updating datasets.
Functionality in this package allows all users to query ScienceBase for
data using a variety of metadata types (query_sb_text,
query_sb_doi, query_sb_spatial). Items and associated
information can be requested by item_get including item parents
item_get_parent and children item_list_children.
Data and attached files can be accessed for all available items through provided
functionality (e.g., item_file_download).
See the function authenticate_sb to authenticate. You'll be
required to pass in your ScienceBase username and password.
Authenticated users can create, update, and remove items (item_list_children,
item_list_children, item_create, item_update,
item_rm).
Report any feedback or bugs at https://github.com/DOI-USGS/sbtools/issues
This connects to SB, authenticates and gets a session token for communicating with SB. If you do not supply a username or password, you will be prompted to enter them.
authenticate_sb(username, password)authenticate_sb(username, password)
username |
Sciencebase username |
password |
Sciencebase password, prompts user if not supplied and
no password is returned by 'keyring::key_get("sciencebase", username)'.
See |
Returns the currently cached SB session token. If there is no authenticated session, returns NULL. Emits a warning if the session has expired.
current_session()current_session()
session = current_session() #null unless currently authenticated sessionsession = current_session() #null unless currently authenticated session
Create a special kind of item on ScienceBase that is intended to be
a "folder" that contains one or more child items. This is similar to
a standard item (item_create) but defaults to showing
child-items on the ScienceBase web interface.
folder_create(parent_id = user_id(), name, ...)folder_create(parent_id = user_id(), name, ...)
parent_id |
An |
name |
(character) the folder name |
... |
A response object
## Not run: folder_create(name="foobar345") ## End(Not run)## Not run: folder_create(name="foobar345") ## End(Not run)
This function quickly checks to see if an identifier exists.
It does a quick head request to skip the overhead of item metadta retrieval.
This will also return FALSE if the identifier exists but is associated
with an item that is unavailable due to permission restrictions.
identifier_exists(sb_id, ...)identifier_exists(sb_id, ...)
sb_id |
An |
... |
Additional parameters are passed on to |
Logical, TRUE or FALSE
# identifier exists identifier_exists(sb_id = "57976a0ce4b021cadec97890") # identifier does not exist identifier_exists(sb_id = "aaaaaaakkkkkkkbbbbbb")# identifier exists identifier_exists(sb_id = "57976a0ce4b021cadec97890") # identifier does not exist identifier_exists(sb_id = "aaaaaaakkkkkkkbbbbbb")
Unless 'token_text' is provided, will open a browser for two factor authentication.
Once logged in, retrieve the token from the user drop down in the upper right hand corner of the browser. Click the icon with the silhouette of a person, and select 'Copy API Token.' The token should be pasted into the popup prompt.
initialize_sciencebase_session(username = NULL, token_text = NULL)initialize_sciencebase_session(username = NULL, token_text = NULL)
username |
email address of sciencebase user. Will be retrieved from the 'sb_user' environment variable if set. A prompt will be raised if not provided. |
token_text |
character json formatted token text. 'token_text' is stashed in R_user_dir and does not need to be re-entered unless it becomes stale. If the token text is provided as input, no popup prompt will be raised. |
Check whether you're logged into a ScienceBase session
is_logged_in()is_logged_in()
Logical, TRUE or FALSE
## Not run: is_logged_in() ## End(Not run)## Not run: is_logged_in() ## End(Not run)
Adds a file to an item
item_append_files(sb_id, files, ..., scrape_files = TRUE)item_append_files(sb_id, files, ..., scrape_files = TRUE)
sb_id |
An |
files |
A string vector of paths to files to be uploaded |
... |
Additional parameters are passed on to |
scrape_files |
logical should the files be scraped for metadata? If TRUE, sciencebase will attempt to create extensions based on the files. For example, for shapefiles, this will result in a shapefile extension to be returned as a facet of the sciencebase item. See item: "58069258e4b0824b2d1d422e" for an example. |
An object of class sbitem
## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_append_files(res$id, "foobar.txt") item_rm(res) ## End(Not run)## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_append_files(res$id, "foobar.txt") item_rm(res) ## End(Not run)
Create a new item on ScienceBase with the requested parent and item title. Info can be provided to populate metadata at the time of creation.
item_create(parent_id = user_id(), title, ..., info)item_create(parent_id = user_id(), title, ..., info)
parent_id |
An |
title |
The title of the new SB item |
... |
|
info |
(optional) list of metadata info for the new item |
An object of class sbitem
## Not run: # Create an item - by default we use your user ID item_create(title = "testing 123") # Pass an object of class sbitem x <- folder_create(user_id(), "foobar456") item_create(x, "foobar456-item") ## End(Not run)## Not run: # Create an item - by default we use your user ID item_create(title = "testing 123") # Pass an object of class sbitem x <- folder_create(user_id(), "foobar456") item_create(x, "foobar456-item") ## End(Not run)
returns TRUE if touple already belongs to a sciencebase item, FALSE if not
item_exists(scheme, type, key, ...)item_exists(scheme, type, key, ...)
scheme |
the identifier scheme |
type |
the identifier type |
key |
the identifier key |
... |
Additional parameters are passed on to |
boolean for whether item exists
## Not run: item_exists('mda_streams','ts_doobs','nwis_01018035') item_exists('mda_streams','site_root','nwis_01018035') ## End(Not run)## Not run: item_exists('mda_streams','ts_doobs','nwis_01018035') item_exists('mda_streams','site_root','nwis_01018035') ## End(Not run)
Function to downlod files attached to an item on SB. Either files can be
specified directly using the names and destinations parameters,
or a dest_dir can be supplied where all attached files will be written
with the names as stored on SB.
item_file_download( sb_id, ..., names, destinations, dest_dir = getwd(), overwrite_file = FALSE )item_file_download( sb_id, ..., names, destinations, dest_dir = getwd(), overwrite_file = FALSE )
sb_id |
An |
... |
Additional parameters are passed on to |
names |
String vector list of file names attached to item that you wish to download. |
destinations |
String vector list of destinations for requested files.
Must be same length as |
dest_dir |
A directory path for saving files when |
overwrite_file |
Boolean indicating if file should be overwritten if it already exists locally |
Character vector of full paths to local files
## Not run: #downloads all files attached to this item item_file_download('627f1572d34e3bef0c9a30d8', dest_dir=tempdir()) #downloads a specific file attached to this item item_file_download('627f1572d34e3bef0c9a30d8', names='example.txt', destinations=file.path(tempdir(), 'out.txt')) ## End(Not run)## Not run: #downloads all files attached to this item item_file_download('627f1572d34e3bef0c9a30d8', dest_dir=tempdir()) #downloads a specific file attached to this item item_file_download('627f1572d34e3bef0c9a30d8', names='example.txt', destinations=file.path(tempdir(), 'out.txt')) ## End(Not run)
Retrieves an item and its metadata from ScienceBase based on its unique ID. Errors if the requested item ID does not exist or access is restricted due to permissions.
item_get(sb_id, ...)item_get(sb_id, ...)
sb_id |
An |
... |
Additional parameters are passed on to |
An object of class sbitem
# Get an item item_get("4f4e4b24e4b07f02db6aea14") # Search for item IDs, then pass to item_get library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) if(inherits(res, "response") && res$status != 404) { ids <- vapply(httr::content(res)$items, "[[", "", "id") lapply(ids[1:3], item_get) }# Get an item item_get("4f4e4b24e4b07f02db6aea14") # Search for item IDs, then pass to item_get library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) if(inherits(res, "response") && res$status != 404) { ids <- vapply(httr::content(res)$items, "[[", "", "id") lapply(ids[1:3], item_get) }
Retrieve specific fields from an SB item
item_get_fields(sb_id, fields, ..., drop = TRUE)item_get_fields(sb_id, fields, ..., drop = TRUE)
sb_id |
An |
fields |
a vector of fields |
... |
Additional parameters are passed on to |
drop |
logical. If only one field is selected, should the list format be dropped? |
List serialization of chosen metadata for an SB item
# Get certain fields from an item item_get_fields("63cb38b2d34e06fef14f40ad", c('title', 'citation', 'contacts')) #' # If only 1 field selection, do or don't drop list format item_get_fields("63cb38b2d34e06fef14f40ad", 'title') item_get_fields("63cb38b2d34e06fef14f40ad", 'title', drop = FALSE)# Get certain fields from an item item_get_fields("63cb38b2d34e06fef14f40ad", c('title', 'citation', 'contacts')) #' # If only 1 field selection, do or don't drop list format item_get_fields("63cb38b2d34e06fef14f40ad", 'title') item_get_fields("63cb38b2d34e06fef14f40ad", 'title', drop = FALSE)
Retrieves the parent of a supplied item based on the ScienceBase item tree hierarchy.
item_get_parent(sb_id, ...)item_get_parent(sb_id, ...)
sb_id |
An |
... |
Additional parameters are passed on to |
An item object representing the parent of the supplied item.
item_get_parent("57976a0ce4b021cadec97890") item_get_parent(item_get("57976a0ce4b021cadec97890"))item_get_parent("57976a0ce4b021cadec97890") item_get_parent(item_get("57976a0ce4b021cadec97890"))
Returns a list of child IDs for a ScienceBase item
item_list_children(sb_id, fields = c("id", "title"), ..., limit = 20)item_list_children(sb_id, fields = c("id", "title"), ..., limit = 20)
sb_id |
An |
fields |
A character vector of requested data fields. Defaults to 'id' and 'title'. Full list of possible fields is available online in SB documentation. |
... |
Additional parameters are passed on to |
limit |
Max children returned. |
List of sbitem for each child item.
## Not run: item_list_children(user_id()) ## End(Not run) item_list_children(as.sbitem('5060b03ae4b00fc20c4f3c8b')) item_list_children(item_get('5060b03ae4b00fc20c4f3c8b'))## Not run: item_list_children(user_id()) ## End(Not run) item_list_children(as.sbitem('5060b03ae4b00fc20c4f3c8b')) item_list_children(item_get('5060b03ae4b00fc20c4f3c8b'))
Lists all files attached to a SB item. Files can be downloaded
from ScienceBase using item_file_download.
(advanced) Recursive options lists all files attached to an item and all children items.
NOTE: A sciencebase item can contain so-called "extensions". The sciencebase item data model refers to the information that describes an extension as a "facet". Some extension facets contain files (such as with a shapefile). The "facet" attribute of the return from this function will contain the name of the facet the file came from if the file was found in a facet.
item_list_files(sb_id, recursive = FALSE, fetch_cloud_urls = TRUE, ...)item_list_files(sb_id, recursive = FALSE, fetch_cloud_urls = TRUE, ...)
sb_id |
An |
recursive |
(logical) List files recursively. Default: |
fetch_cloud_urls |
(logical) fetch a tokenized cloud download URLs? Default: |
... |
Additional parameters are passed on to |
A data.frame with columns fname, size, url, and facet. If item has no attached files, returns a zero row data.frame.
## Not run: #regular files item_list_files("57976a0ce4b021cadec97890") # files in facets item_list_files("5ebe92af82ce476925e44b8f") # list files recursively ## create item id <- item_create(user_id(), title="some title") ## 1. create nested item w/ file file <- system.file("examples", "books.json", package = "sbtools") id2 <- item_create(id, title = "newest-thing") item_upload_create(id2, file) ## 2. create nested item w/ file file <- system.file("examples", "species.json", package = "sbtools") id3 <- item_create(id, title = "a-new-thing") item_upload_create(id3, file) ## 3. create nested item w/ file file <- system.file("examples", "data.csv", package = "sbtools") id4 <- item_create(id, title = "another-thing") item_upload_create(id4, file) item_list_files(id = '56562348e4b071e7ea53e09d', recursive = FALSE) # default item_list_files(id = '56562348e4b071e7ea53e09d', recursive = TRUE) ## End(Not run)## Not run: #regular files item_list_files("57976a0ce4b021cadec97890") # files in facets item_list_files("5ebe92af82ce476925e44b8f") # list files recursively ## create item id <- item_create(user_id(), title="some title") ## 1. create nested item w/ file file <- system.file("examples", "books.json", package = "sbtools") id2 <- item_create(id, title = "newest-thing") item_upload_create(id2, file) ## 2. create nested item w/ file file <- system.file("examples", "species.json", package = "sbtools") id3 <- item_create(id, title = "a-new-thing") item_upload_create(id3, file) ## 3. create nested item w/ file file <- system.file("examples", "data.csv", package = "sbtools") id4 <- item_create(id, title = "another-thing") item_upload_create(id4, file) item_list_files(id = '56562348e4b071e7ea53e09d', recursive = FALSE) # default item_list_files(id = '56562348e4b071e7ea53e09d', recursive = TRUE) ## End(Not run)
Move item from one folder to another
item_move(sb_id, id_new, ...)item_move(sb_id, id_new, ...)
sb_id |
An |
id_new |
Folder/item to move |
... |
Additional parameters are passed on to |
An object of class sbitem. Same as id, but with new
parent id
## Not run: # create 1st folder (fold1 <- folder_create(user_id(), "bear123")) (res <- item_create(fold1, "item-to-move")) # create 2nd folder (fold2 <- folder_create(user_id(), "bear456")) # move item in 1st folder to 2nd folder (res2 <- item_move(res, fold2)) # test identical identical(res2$parentId, fold2$id) ## End(Not run)## Not run: # create 1st folder (fold1 <- folder_create(user_id(), "bear123")) (res <- item_create(fold1, "item-to-move")) # create 2nd folder (fold2 <- folder_create(user_id(), "bear456")) # move item in 1st folder to 2nd folder (res2 <- item_move(res, fold2)) # test identical identical(res2$parentId, fold2$id) ## End(Not run)
moves a cloud file from the S3 bucket only available via ScienceBase authenticated services to a public S3 bucket.
item_publish_cloud(sb_id, files, ...)item_publish_cloud(sb_id, files, ...)
sb_id |
An |
files |
A string vector of paths to files to be uploaded |
... |
Additional parameters are passed on to |
web service response invisibly.
## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_upload_cloud(res$id, "foobar.txt") item_publish_cloud(res$id, "foobar.txt") ## End(Not run)## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_upload_cloud(res$id, "foobar.txt") item_publish_cloud(res$id, "foobar.txt") ## End(Not run)
Renames files attached to an SB item.
item_rename_files(sb_id, names, new_names, ...)item_rename_files(sb_id, names, new_names, ...)
sb_id |
An |
names |
List of names of files to rename |
new_names |
List of new file names to use |
... |
Additional parameters are passed on to |
## Not run: names = c('file1.txt', 'file2.txt') new_names = c('newname1.txt', 'newname2.txt') item_rename_files('sbid', names, new_names) ## End(Not run)## Not run: names = c('file1.txt', 'file2.txt') new_names = c('newname1.txt', 'newname2.txt') item_rename_files('sbid', names, new_names) ## End(Not run)
replaces existing files associated with an item with a new one.
NOTE: This function will not replace files stored in facets. Until and if facet support is added, direct alteration of the science base item object is required to manipulate facets.
item_replace_files(sb_id, files, ..., all = FALSE, scrape_files = FALSE)item_replace_files(sb_id, files, ..., all = FALSE, scrape_files = FALSE)
sb_id |
An |
files |
A character vector of file paths |
... |
Additional parameters are passed on to |
all |
A boolean indicating if all attached files should be removed before
uploading new files. FALSE if only files with matching names should be replaced.
If you wish to upload files with duplicate names, see |
scrape_files |
logical should the files be scraped for metadata? If TRUE, sciencebase will attempt to create extensions based on the files. For example, for shapefiles, this will result in a shapefile extension to be returned as a facet of the sciencebase item. See item: "58069258e4b0824b2d1d422e" for an example. |
Remove an item from ScienceBase. This is not reversible and will delete an item and its attached files. (advanced) Recursive is to be used with care and could result in unexpected file deletion.
item_rm(sb_id, ..., limit = 1000, recursive = FALSE)item_rm(sb_id, ..., limit = 1000, recursive = FALSE)
sb_id |
An |
... |
Additional parameters are passed on to |
limit |
The maximum number of child items to remove when called with recursive=TRUE. |
recursive |
logical, FALSE by default. CAUTION: setting recursive=TRUE means that not only will this item be deleted, but so will all its child items and their child items and so on. |
httr response object
## Not run: res <- item_create(user_id(), "item-to-delete") item_rm(res) ## End(Not run)## Not run: res <- item_create(user_id(), "item-to-delete") item_rm(res) ## End(Not run)
Removes existing files associated with an item.
NOTE: This function will not alter facets which can also
contain facets. To manipulate facets, the facet element of
a sciencebase item must be altered and updated with item_update.
This function is the key way to remove files attached to SB items.
item_rm_files(sb_id, files, ...)item_rm_files(sb_id, files, ...)
sb_id |
An |
files |
A character vector of file names to remove. If not supplied, defaults to removing all attached files. |
... |
Additional parameters are passed on to |
An updated object of class sbitem
## Not run: res <- item_create(user_id(), "item456") cat("foo bar", file = "foobar.txt") item_append_files(res, "foobar.txt") res <- item_get(res) res$files[[1]]$name res2 <- item_rm_files(res) res2$files ## End(Not run)## Not run: res <- item_create(user_id(), "item456") cat("foo bar", file = "foobar.txt") item_append_files(res, "foobar.txt") res <- item_get(res) res$files[[1]]$name res2 <- item_rm_files(res) res2$files ## End(Not run)
Updates metadata associated with a ScienceBase item based on supplied list of new or updated metadata elements.
item_update(sb_id, info, ...)item_update(sb_id, info, ...)
sb_id |
An |
info |
list of metadata info (key-value pairs) to change on the item |
... |
Additional parameters are passed on to |
An object of class sbitem
## Not run: res <- item_create(user_id(), "item-to-update") out <- item_update(res, list(title = "item-updated")) out$title ## End(Not run)## Not run: res <- item_create(user_id(), "item-to-update") out <- item_update(res, list(title = "item-updated")) out$title ## End(Not run)
Adds or updates an item's alternative identifier. This can add
additional identifiers or update those already in place. See
query_item_identifier for finding items based on alternative
identifier.
item_update_identifier(sb_id, scheme, type, key, ...)item_update_identifier(sb_id, scheme, type, key, ...)
sb_id |
An |
scheme |
The identifier scheme |
type |
The identifier type |
key |
The identifier key |
... |
Additional parameters are passed on to |
## Not run: initialize_sciencebase_session() item_update_identifier("5485fd99e4b02acb4f0c7e81", "scheme", "type", "key") ## End(Not run)## Not run: initialize_sciencebase_session() item_update_identifier("5485fd99e4b02acb4f0c7e81", "scheme", "type", "key") ## End(Not run)
Adds a file to an item in cloud storage
item_upload_cloud(sb_id, files, ..., status = TRUE)item_upload_cloud(sb_id, files, ..., status = TRUE)
sb_id |
An |
files |
A string vector of paths to files to be uploaded |
... |
Additional parameters are passed on to |
status |
logical display upload status? |
Success message invisibly. NOTE: cloud processing can take some time so the added file may not appear immediately. For this reason, a sciencebase item json is NOT returned as is done with other similar functions.
## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_upload_cloud(res$id, "foobar.txt") ## End(Not run)## Not run: res <- item_create(user_id(), "testing 123") cat("foo bar", file = "foobar.txt") item_upload_cloud(res$id, "foobar.txt") ## End(Not run)
Create a new item with files attached, all in one call to SB
item_upload_create(parent_id, files, ..., scrape_files = TRUE)item_upload_create(parent_id, files, ..., scrape_files = TRUE)
parent_id |
An |
files |
A string vector of paths to files to be uploaded |
... |
|
scrape_files |
logical should the files be scraped for metadata? If TRUE, sciencebase will attempt to create extensions based on the files. For example, for shapefiles, this will result in a shapefile extension to be returned as a facet of the sciencebase item. See item: "58069258e4b0824b2d1d422e" for an example. |
An object of class sbitem
## Not run: # You'll need a parent id for a folder/item ## here, using your highest level parent folder file <- system.file("examples", "books.json", package = "sbtools") item_upload_create(user_id(), file) ## End(Not run)## Not run: # You'll need a parent id for a folder/item ## here, using your highest level parent folder file <- system.file("examples", "books.json", package = "sbtools") item_upload_create(user_id(), file) ## End(Not run)
Either creates or updates (if item already exists)
item_upsert(parent_id = user_id(), title = NULL, ..., info = NULL)item_upsert(parent_id = user_id(), title = NULL, ..., info = NULL)
parent_id |
An |
title |
The title of the new SB item |
... |
|
info |
(optional) list of metadata info for the new item |
An object of class sbitem
## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create an item - by default we use your user ID (x <- item_upsert(title = aname())) # Call item_upsert again, updates this time item_upsert(x, info = list( contacts = list(list(name = "Suzy")) ) ) ## End(Not run)## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create an item - by default we use your user ID (x <- item_upsert(title = aname())) # Call item_upsert again, updates this time item_upsert(x, info = list( contacts = list(list(name = "Suzy")) ) ) ## End(Not run)
A method to create multiple ScienceBase items with a single call and a single HTTP service request. Can be useful for improving performance of creating a large number of items at once.
items_create(parent_id = user_id(), title, ..., info = NULL)items_create(parent_id = user_id(), title, ..., info = NULL)
parent_id |
An |
title |
Two or more titles for the new SB items |
... |
Additional parameters are passed on to |
info |
(optional) list of metadata info for the new items. for each item include a named list of variables |
The length of the title and info values must be the same
length - however, the parent_id can be of length 1 or equal to the length
of each of title and info parameters
One or more objects of class sbitem in a list
## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create some items - by default we use your user ID items_create(title = c(aname(), aname())) # add additional items in the info parameter - by default we use your user ID items_create(title = c(aname(), aname()), info = list( list(contacts = list(list(name = "Suzy"))), list(contacts = list(list(name = "Brandy"))) ) ) # another example with more information - by default we use your user ID items_create(title = c(aname(), aname()), info = list( list(contacts = list(list(name = "Suzy"))), list(contacts = list(list(name = "Brandy"))) ) ) # Pass an object of class sbitem (x <- folder_create(user_id(), aname())) items_create(x, title = c(aname(), aname())) ## End(Not run)## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create some items - by default we use your user ID items_create(title = c(aname(), aname())) # add additional items in the info parameter - by default we use your user ID items_create(title = c(aname(), aname()), info = list( list(contacts = list(list(name = "Suzy"))), list(contacts = list(list(name = "Brandy"))) ) ) # another example with more information - by default we use your user ID items_create(title = c(aname(), aname()), info = list( list(contacts = list(list(name = "Suzy"))), list(contacts = list(list(name = "Brandy"))) ) ) # Pass an object of class sbitem (x <- folder_create(user_id(), aname())) items_create(x, title = c(aname(), aname())) ## End(Not run)
A method to update multiple ScienceBase items with a single call and a single HTTP service request. Can be useful for improving performance of updating a large number of items at once.
items_update(sb_id, info, ...)items_update(sb_id, info, ...)
sb_id |
An |
info |
list of metadata info (key-value pairs) to change on the item |
... |
Additional parameters are passed on to |
If length of sb_id > 1, then length of info input must be the same
One or more objects of class sbitem in a list
## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") res <- items_create(user_id(), title = c(aname(), aname())) out <- items_update(res, info = list( list(title = aname()), list(title = aname()) ) ) vapply(out, "[[", "", "title") ## End(Not run)## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") res <- items_create(user_id(), title = c(aname(), aname())) out <- items_update(res, info = list( list(title = aname()), list(title = aname()) ) ) vapply(out, "[[", "", "title") ## End(Not run)
Either creates or updates (if items already exist)
items_upsert(parent_id = user_id(), title = NULL, ..., info = NULL)items_upsert(parent_id = user_id(), title = NULL, ..., info = NULL)
parent_id |
An |
title |
The title of the new SB item |
... |
|
info |
(optional) list of metadata info for the new item |
An object of class sbitem
## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create some item - by default we use your user ID z1 <- item_create(title = aname()) z2 <- item_create(title = aname()) # Upsert items (x <- items_upsert(list(z1, z2), title = c(aname(), aname()))) # Call item_upsert again, updates this time items_upsert(x, info = list( contacts = list(list(name = "Suzy")) ) ) ## End(Not run)## Not run: # helper function to make a random name aname <- function() paste0(sample(letters, size = 5, replace = TRUE), collapse = "") # Create some item - by default we use your user ID z1 <- item_create(title = aname()) z2 <- item_create(title = aname()) # Upsert items (x <- items_upsert(list(z1, z2), title = c(aname(), aname()))) # Call item_upsert again, updates this time items_upsert(x, info = list( contacts = list(list(name = "Suzy")) ) ) ## End(Not run)
Find all items under a scheme or also query by for a specific type and key
query_item_identifier(scheme, type = NULL, key = NULL, ..., limit = 20)query_item_identifier(scheme, type = NULL, key = NULL, ..., limit = 20)
scheme |
The identifier scheme |
type |
(optional) The identifier type |
key |
(optional) The identifier key |
... |
Additional parameters are passed on to |
limit |
Max number of matching items to return |
The SB item id for the matching item. NULL if no matching item found.
## Not run: authenticate_sb() ex_item = item_create(title='identifier example') item_update_identifier(ex_item, 'project1', 'dataset1', 'key1') ex2_item = item_create(title='identifier example 2') item_update_identifier(ex2_item, 'project1', 'dataset1', 'key2') #query the specific item query_item_identifier('project1', 'dataset1', 'key1') #or get the collection of items based on the ID hierarchy query_item_identifier('project1') item_rm(ex_item) item_rm(ex2_item) ## End(Not run)## Not run: authenticate_sb() ex_item = item_create(title='identifier example') item_update_identifier(ex_item, 'project1', 'dataset1', 'key1') ex2_item = item_create(title='identifier example 2') item_update_identifier(ex2_item, 'project1', 'dataset1', 'key2') #query the specific item query_item_identifier('project1', 'dataset1', 'key1') #or get the collection of items based on the ID hierarchy query_item_identifier('project1') item_rm(ex_item) item_rm(ex2_item) ## End(Not run)
Search for text in the title, abstract, etc. within an SB folder and any subfolders.
query_item_in_folder(text, folder, ..., limit = 20)query_item_in_folder(text, folder, ..., limit = 20)
text |
text in the title, abstract, etc. of the desired item |
folder |
an SB item ID for the folder to search in |
... |
Additional parameters are passed on to |
limit |
Max number of matching items to return |
A list of matching items as sbitem objects.
Query SB for items using generic query parameters
query_items(query_list, ...)query_items(query_list, ...)
query_list |
List of item query selectors. See Details. |
... |
Additional parameters are passed on to |
The following is a list of query parameters you can use
in the query_list parameter.
s (character): Only option: "Search"
format (character): One of "json", "xml", "csv", or "atom"
q (character): Query string
q (character): Lucene query string
max (integer): Number of records to return. Default: 20
offset (integer): Record to start at. Default: 1
fields (character): Character vector of fields to return
folderId (character): Alphanumeric string representing folder ID
parentId (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, but not within sub-folders.
sort (character) One of "firstContact", "dateCreated", "lastUpdated", or "title". By default sorted by search score
order (character) One of "asc" or "desc"
ids Vector of item ids.
ancestors (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, even within sub-folders. Used as a filter
tags Filter by tags, e.g, "distribution". Used as a filter
browseCategory One of .... Used as a filter
browseType One of .... Used as a filter
dateRange A json string with keys dateType and choice. Where dateType is one of Acquisition, Award, Collected, dateCreated, Received, Reported, Transmitted, Due, End, Info, lastUpdated, Publication, Release, or Start. And where choice is one of day, week, month, year, or range (if range selected, also supply start and end keys with dates of the form YYYY-MM-DD). Used as a filter
projectStatus One of Active, Approved, Completed, In Progress, Proposed. Used as a filter
spatialQuery A WKT string. Used as a filter
extentQuery Use existing extents (footprints) to search against item bounding boxes and representational points. This is a alphanumeric string.
An object of class response
query_item_identifier, query_item_in_folder
## Not run: # Basic query library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) httr::content(res) # Paging ## max - number of results res <- query_items(list(s = "Search", q = "water", format = "json", max = 2)) length(httr::content(res)$items) res <- query_items(list(s = "Search", q = "water", format = "json", max = 30)) length(httr::content(res)$items) ## offset - start at certain record res <- query_items(list(s = "Search", q = "water", format = "json", max = 30, offset = 10)) httr::content(res) ## links - use links given in output for subsequent queries httr::content(httr::GET( content(res)$nextlink$url )) # Return only certain fields res <- query_items(list(s = "Search", q = "water", format = "json", fields = 'title')) httr::content(res)$items[[1]] # Search a folder ID res <- query_items(list(s = "Search", q = "water", format = "json", folderId = '504216b9e4b04b508bfd337d')) httr::content(res)$items # Filter by ancestor query_items(list(s = "Search", ancestors = "4f831626e4b0e84f6086809b", format = "json")) # Filter by tags content(query_items(list(s = "Search", tags = "distribution", format = "json"))) # Filter by browse category content(query_items(list(s = "Search", browseCategory = "Image", format = "json"))) # Filter by browse type content(query_items(list(s = "Search", browseType = "Collection", format = "json"))) # Filter by WKT geometry string wkt1 <- "POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))" wkt2 <- "POLYGON((-104.4 38.3,-95.2 38.3,-95.2 33.7,-104.4 34.0,-104.4 38.3))" content(query_items(list(s = "Search", spatialQuery = wkt1, format = "json"))) content(query_items(list(s = "Search", spatialQuery = wkt1, spatialQuery = wkt2, format = "json"))) # Project status content(query_items(list(s = "Search", projectStatus = "Active", format = "json"))) # Date range query_items(list(s = "Search", dateRange = '{"dateType":"Collected","choice":"year"}', format = "json")) query_items(list(s = "Search", dateRange = '{"dateType":"lastUpdated","choice":"month"}', format = "json")) query_items(list(s = "Search", dateRange = '{"dateType":"Release","choice":"range","start":"2014-09-01","end":"2015-09-01"}', format = "json")) # Extent query ## just a alphanumeric code content(query_items(list(s = "Search", extentQuery = '2873462', format = "json"))) ## with buffering, intersect content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"intersects","buffer":"5"}', format = "json"))) ## with buffering, within content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"within","buffer":"5"}', format = "json"))) ## with buffering, within content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"disjoint","buffer":"5"}', format = "json"))) # Lucene query ## note, you have to pass the q parameter if you pass the lq parameter content(query_items(list(s = "Search", q = "", lq = '"sage OR grouse"'))) ## End(Not run)## Not run: # Basic query library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) httr::content(res) # Paging ## max - number of results res <- query_items(list(s = "Search", q = "water", format = "json", max = 2)) length(httr::content(res)$items) res <- query_items(list(s = "Search", q = "water", format = "json", max = 30)) length(httr::content(res)$items) ## offset - start at certain record res <- query_items(list(s = "Search", q = "water", format = "json", max = 30, offset = 10)) httr::content(res) ## links - use links given in output for subsequent queries httr::content(httr::GET( content(res)$nextlink$url )) # Return only certain fields res <- query_items(list(s = "Search", q = "water", format = "json", fields = 'title')) httr::content(res)$items[[1]] # Search a folder ID res <- query_items(list(s = "Search", q = "water", format = "json", folderId = '504216b9e4b04b508bfd337d')) httr::content(res)$items # Filter by ancestor query_items(list(s = "Search", ancestors = "4f831626e4b0e84f6086809b", format = "json")) # Filter by tags content(query_items(list(s = "Search", tags = "distribution", format = "json"))) # Filter by browse category content(query_items(list(s = "Search", browseCategory = "Image", format = "json"))) # Filter by browse type content(query_items(list(s = "Search", browseType = "Collection", format = "json"))) # Filter by WKT geometry string wkt1 <- "POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))" wkt2 <- "POLYGON((-104.4 38.3,-95.2 38.3,-95.2 33.7,-104.4 34.0,-104.4 38.3))" content(query_items(list(s = "Search", spatialQuery = wkt1, format = "json"))) content(query_items(list(s = "Search", spatialQuery = wkt1, spatialQuery = wkt2, format = "json"))) # Project status content(query_items(list(s = "Search", projectStatus = "Active", format = "json"))) # Date range query_items(list(s = "Search", dateRange = '{"dateType":"Collected","choice":"year"}', format = "json")) query_items(list(s = "Search", dateRange = '{"dateType":"lastUpdated","choice":"month"}', format = "json")) query_items(list(s = "Search", dateRange = '{"dateType":"Release","choice":"range","start":"2014-09-01","end":"2015-09-01"}', format = "json")) # Extent query ## just a alphanumeric code content(query_items(list(s = "Search", extentQuery = '2873462', format = "json"))) ## with buffering, intersect content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"intersects","buffer":"5"}', format = "json"))) ## with buffering, within content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"within","buffer":"5"}', format = "json"))) ## with buffering, within content(query_items(list(s = "Search", extentQuery = '{"extent":2873462, "relation":"disjoint","buffer":"5"}', format = "json"))) # Lucene query ## note, you have to pass the q parameter if you pass the lq parameter content(query_items(list(s = "Search", q = "", lq = '"sage OR grouse"'))) ## End(Not run)
Generic SB query function to construct advanced queries.
The following is a list of query parameters you can use
in the query_list parameter.
q (character): Query string
q (character): Lucene query string
fields (character): Character vector of fields to return
folderId (character): Alphanumeric string representing folder ID
parentId (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, but not within sub-folders.
sort (character) One of "firstContact", "dateCreated", "lastUpdated", or "title". By default sorted by search score
order (character) One of "asc" or "desc"
ids Vector of item ids.
ancestors (character): Alphanumeric string representing folder ID. This can be used to return all children items within the folder, even within sub-folders. Used as a filter
tags Filter by tags, e.g, "distribution". Used as a filter
browseCategory One of .... Used as a filter
browseType One of .... Used as a filter
dateRange A json string with keys dateType and choice. Where dateType is one of Acquisition, Award, Collected, dateCreated, Received, Reported, Transmitted, Due, End, Info, lastUpdated, Publication, Release, or Start. And where choice is one of day, week, month, year, or range (if range selected, also supply start and end keys with dates of the form YYYY-MM-DD). Used as a filter
projectStatus One of Active, Approved, Completed, In Progress, Proposed. Used as a filter
spatialQuery A WKT string. Used as a filter
extentQuery Use existing extents (footprints) to search against item bounding boxes and representational points. This is a alphanumeric string.
query_sb(query_list, ..., limit = 20)query_sb(query_list, ..., limit = 20)
query_list |
List of item query selectors. See Details. |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
A list of sbitem objects
## Not run: query_sb(list(q = "water")) # Search by project status query_sb(list(projectStatus = "Active")) # Search a folder ID query_sb(list(q = "water", folderId = '504216b9e4b04b508bfd337d')) # Filter by ancestor query_sb(list(ancestors = "4f831626e4b0e84f6086809b")) # Filter by tags query_sb(list(tags = "distribution")) # Filter by browse category query_sb(list(browseCategory = "Image")) # Filter by browse type query_sb(list(browseType = "Map Service")) # Filter by WKT geometry string wkt1 <- "POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))" wkt2 <- "POLYGON((-104.4 38.3,-95.2 38.3,-95.2 33.7,-104.4 34.0,-104.4 38.3))" query_sb(list(spatialQuery = wkt1)) query_sb(list(spatialQuery = wkt1, spatialQuery = wkt2)) # Date range query_sb(list(dateRange = '{"dateType":"Collected","choice":"year"}')) query_sb(list(dateRange = '{"dateType":"lastUpdated","choice":"month"}')) query_sb(list(dateRange = '{"dateType":"Release","choice":"range","start":"2014-09-01","end":"2015-09-01"}')) ## End(Not run)## Not run: query_sb(list(q = "water")) # Search by project status query_sb(list(projectStatus = "Active")) # Search a folder ID query_sb(list(q = "water", folderId = '504216b9e4b04b508bfd337d')) # Filter by ancestor query_sb(list(ancestors = "4f831626e4b0e84f6086809b")) # Filter by tags query_sb(list(tags = "distribution")) # Filter by browse category query_sb(list(browseCategory = "Image")) # Filter by browse type query_sb(list(browseType = "Map Service")) # Filter by WKT geometry string wkt1 <- "POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))" wkt2 <- "POLYGON((-104.4 38.3,-95.2 38.3,-95.2 33.7,-104.4 34.0,-104.4 38.3))" query_sb(list(spatialQuery = wkt1)) query_sb(list(spatialQuery = wkt1, spatialQuery = wkt2)) # Date range query_sb(list(dateRange = '{"dateType":"Collected","choice":"year"}')) query_sb(list(dateRange = '{"dateType":"lastUpdated","choice":"month"}')) query_sb(list(dateRange = '{"dateType":"Release","choice":"range","start":"2014-09-01","end":"2015-09-01"}')) ## End(Not run)
Queries ScienceBase for items with matching datatype.
query_sb_datatype(datatype, ..., limit = 20)query_sb_datatype(datatype, ..., limit = 20)
datatype |
Character string indicating datatype. See |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
A list of sbitem objects. List of length 0
means no matches were found.
#query for items with WFS Layer data query_sb_datatype('Static Map Image') #query for US Topo maps query_sb_datatype('Map Service')#query for items with WFS Layer data query_sb_datatype('Static Map Image') #query for US Topo maps query_sb_datatype('Map Service')
Queries ScienceBase for items with timestamps within a certain date/time range.
query_sb_date( start = as.POSIXct("1970-01-01"), end = Sys.time(), date_type = "lastUpdated", ..., limit = 20 )query_sb_date( start = as.POSIXct("1970-01-01"), end = Sys.time(), date_type = "lastUpdated", ..., limit = 20 )
start |
Start date as |
end |
End date as |
date_type |
Which object timestamp to query against. Options are (case sensitive): 'Acquisition', 'Award', 'Collected', 'dateCreated', 'Received', 'Reported', 'Transmitted', 'Due', 'End', 'Info', 'lastUpdated', 'Publication', 'Release', 'Repository Created', 'Repository Updated', 'Start'. |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
## Not run: # find items updated today query_sb_date(Sys.time(), Sys.time()) # find items with publications from the 1970's query_sb_date(as.POSIXct('1970-01-01'), as.POSIXct('1980-01-01'), date_type='Publication', limit=1000) ## End(Not run)## Not run: # find items updated today query_sb_date(Sys.time(), Sys.time()) # find items with publications from the 1970's query_sb_date(as.POSIXct('1970-01-01'), as.POSIXct('1980-01-01'), date_type='Publication', limit=1000) ## End(Not run)
Queries for ScienceBase items with a specific DOI identifier. In ScienceBase, these are stored as additional unique identifiers.
query_sb_doi(doi, ..., limit = 20)query_sb_doi(doi, ..., limit = 20)
doi |
DOI to search for as character |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
A list of sbitem objects. List of length 0
means no matches were found.
#Two example DOI-specific queries query_sb_doi('10.5066/F7M043G7') query_sb_doi('10.5066/F7Z60M35')#Two example DOI-specific queries query_sb_doi('10.5066/F7M043G7') query_sb_doi('10.5066/F7Z60M35')
Queries ScienceBase based on a spatial bounding box. Accepts either an sp spatial data object (uses the spatial object's bounding box) or long/lat coordinates defining the bounding box limits.
query_sb_spatial(bbox, long, lat, bb_wkt, ..., limit = 20)query_sb_spatial(bbox, long, lat, bb_wkt, ..., limit = 20)
bbox |
An sf spatial data object. The bounding box of the object is used for the query. |
long |
A vector of longitude values that will define the boundaries of a bounding box. Min and Max of supplied longitudes are used. (alternate option to bbox). |
lat |
A vector of latitude values that will define the boundaries of a bounding box. Min and Max of supplied latitude are used. (alternate option to bbox). |
bb_wkt |
A character string using the Well Known Text (WKT) standard for defining spatial data. Must be a POLYGON WKT object. |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
#specify the latitude and longitude points to define the bounding box range. # This is simply bottom left and top right points query_sb_spatial(long=c(-104.4, -95.1), lat=c(37.5, 41.0), limit=3) #use a pre-formatted WKT polygon to grab data query_sb_spatial(bb_wkt="POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))", limit=3)#specify the latitude and longitude points to define the bounding box range. # This is simply bottom left and top right points query_sb_spatial(long=c(-104.4, -95.1), lat=c(37.5, 41.0), limit=3) #use a pre-formatted WKT polygon to grab data query_sb_spatial(bb_wkt="POLYGON((-104.4 41.0,-95.1 41.0,-95.1 37.5,-104.4 37.5,-104.4 41.0))", limit=3)
Queries for ScienceBase items that have matching text in the title or description
query_sb_text(text, ..., limit = 20)query_sb_text(text, ..., limit = 20)
text |
Text string for search |
... |
Additional parameters are passed on to |
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
A list of sbitem objects. List of length 0
means no matches were found.
#query for a person's name query_sb_text('Luna Leopold') #query for one of the old river gaging stations query_sb_text('Lees Ferry')#query for a person's name query_sb_text('Luna Leopold') #query for one of the old river gaging stations query_sb_text('Lees Ferry')
Queries ScienceBase for the list of all available datatypes. This can be
coupled with query_sb_datatype to query based on the type of data
sb_datatypes(limit = 50)sb_datatypes(limit = 50)
limit |
Maximum number of returned items. Will do paging to retrieve results when limit is over 1000. Use with caution, queries 10k results are slow. |
## Not run: #return all datatypes (limit 50 by default) sb_datatypes() ## End(Not run)## Not run: #return all datatypes (limit 50 by default) sb_datatypes() ## End(Not run)
Ping ScienceBase to see if it's available
sb_ping(...)sb_ping(...)
... |
Additional parameters are passed on to |
Boolean (TRUE) indicating if a connection to ScienceBase can be established and if it is responding as expected. FALSE otherwise.
#TRUE if all is well and SB can be contacted sb_ping()#TRUE if all is well and SB can be contacted sb_ping()
ScienceBase item class
as.sbitem(x, ...) ## Default S3 method: as.sbitem(x, ...) is.sbitem(x)as.sbitem(x, ...) ## Default S3 method: as.sbitem(x, ...) is.sbitem(x)
x |
Input, variety of things, character, list, or sbitem class object |
... |
Further args passed on to |
# Single item from item_get() item_get("57976a0ce4b021cadec97890") # Get many w/ e.g., an lapply() call library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) if(res$status == 200) { ids <- vapply(httr::content(res)$items, "[[", "", "id") (out <- lapply(ids[1:3], item_get)) } # create item class from only an item ID as.sbitem("5ebe92af82ce476925e44b8f") # sbitem gives back itself (x <- as.sbitem("5ebe92af82ce476925e44b8f")) as.sbitem(x)# Single item from item_get() item_get("57976a0ce4b021cadec97890") # Get many w/ e.g., an lapply() call library("httr") res <- query_items(list(s = "Search", q = "water", format = "json")) if(res$status == 200) { ids <- vapply(httr::content(res)$items, "[[", "", "id") (out <- lapply(ids[1:3], item_get)) } # create item class from only an item ID as.sbitem("5ebe92af82ce476925e44b8f") # sbitem gives back itself (x <- as.sbitem("5ebe92af82ce476925e44b8f")) as.sbitem(x)
Get the details associated with current ScienceBase user session.
session_details()session_details()
list, if not logged in states that, but if logged in, user details
## Not run: session_details() ## End(Not run)## Not run: session_details() ## End(Not run)
Checks the state of your Sciencebase session, re-authenticates if the session is expired, and simply renews if the session is active.
session_renew(password, ..., username)session_renew(password, ..., username)
password |
The password to use, if needed, to renew the session. |
... |
Any additional parameters are currently ignored. |
username |
Optional. Used only to confirm that the current username is
what you expect; if you want to switch usernames, use
|
Returns the session object.
## Not run: # an empty call is sufficient if the session is current, # but will break if haven't been logged in before session_renew() # include a password if session may be expired session_renew('newpass') # optionally confirm the value of the current username session_renew(username='[email protected]', 'newpass') ## End(Not run)## Not run: # an empty call is sufficient if the session is current, # but will break if haven't been logged in before session_renew() # include a password if session may be expired session_renew('newpass') # optionally confirm the value of the current username session_renew(username='[email protected]', 'newpass') ## End(Not run)
A session is considered valid if it is NULL or a true, non-expired SB session
session_validate()session_validate()
This function only operates on the active initialized session.
TRUE/FALSE indicating if session is valid and can be used.
Returns TRUE if session is NULL as well.
Sets the internal URLS used to either the production or development (beta) SB server. URLS are stored internally to the package
set_endpoint(endpoint = c("production", "development"))set_endpoint(endpoint = c("production", "development"))
endpoint |
Indicate which SB endpoint
you want to use options: |
Luke Winslow
set_endpoint('prod') # getting item from production SB servers item_get('5060b03ae4b00fc20c4f3c8b') set_endpoint('dev') # getting item from beta SB servers item_get('521e4686e4b051c878dc35d0')set_endpoint('prod') # getting item from production SB servers item_get('5060b03ae4b00fc20c4f3c8b') set_endpoint('dev') # getting item from beta SB servers item_get('521e4686e4b051c878dc35d0')
Required for creating items
user_id(...)user_id(...)
... |
Additional parameters are passed on to |
A single character string, your user id
## Not run: user_id() ## End(Not run)## Not run: user_id() ## End(Not run)