standard_description_function | R Documentation |
Place to stash roxygen descriptions for common paramaters used accross package
standard_description_function(project, app_id, file_id, file, auth, status)
project |
a sevenbridges 'Project' object. See readme for instructions on how to create this object |
app_id |
unique app id: <project_id>/<short_app_id>/<version_number>. Can find this by running cavatica_app_list_all, cavatica_app_search, or using web platform (ID is everything after # in URL. May still need to add /<version_number>) (string) |
file_id |
id of file. Can be found using api OR using the wep portal (see number after #) (string) |
file |
a sevenbridges file object. E.g. that prduced by cavatica_file_from_filepath |
auth |
authorisation object used to interface with cavatica api. Retrieved by running cavatica_api_connect() |
status |
one of: c("all", "queued", "draft", "running", "completed", "aborted", "failed") |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.