Package: sevenbridges 1.43.0

Phil Webster

sevenbridges: Seven Bridges Platform API Client and Common Workflow Language Tool Builder in R

R client and utilities for Seven Bridges platform API, from Cancer Genomics Cloud to other Seven Bridges supported platforms.

Authors:Phil Webster [aut, cre], Soner Koc [aut], Nan Xiao [aut], Tengfei Yin [aut], Dusan Randjelovic [ctb], Emile Young [ctb], Velsera [cph, fnd]

sevenbridges_1.43.0.tar.gz
sevenbridges_1.43.0.zip(r-4.7)sevenbridges_1.43.0.zip(r-4.6)sevenbridges_1.43.0.zip(r-4.5)
sevenbridges_1.43.0.tgz(r-4.6-any)sevenbridges_1.43.0.tgz(r-4.5-any)
sevenbridges_1.43.0.tar.gz(r-4.7-any)sevenbridges_1.43.0.tar.gz(r-4.6-any)
sevenbridges_1.43.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
sevenbridges/json (API)

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

Bug tracker:https://github.com/sbg/sevenbridges-r/issues

Pkgdown/docs site:https://sbg.github.io

On BioConductor:sevenbridges-1.43.0(bioc 3.24)sevenbridges-1.42.0(bioc 3.23)

softwaredataimportthirdpartyclientapi-clientbioconductorbioinformaticscloudcommon-workflow-languagesevenbridges

7.44 score 37 stars 25 scripts 158 exports 25 dependencies

Last updated from:619d6c744e. Checks:1 ERROR, 7 NOTE, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
bioc-checksERROR195
linux-devel-x86_64NOTE247
source / vignettesOK237
linux-release-x86_64NOTE286
macos-release-arm64NOTE151
macos-oldrel-arm64NOTE163
windows-develNOTE188
windows-releaseNOTE183
windows-oldrelNOTE189
wasm-releaseOK122

Exports:%>>%access_leveladd_tagaddIdNumage_at_diagnosisaliquot_idaliquot_uuidanalysis_uuidanyReqAnyRequirementapiAppappTypeargslistasListAuthawsAWSInstanceTypeRequirementbatchBindingcase_idcase_uuidCCBListCLBcli_list_projectscli_list_tagscli_uploadCOBCommandInputParameterCommandInputSchemaCommandLineBindingCommandLineToolCommandOutputBindingCommandOutputParameterCommandOutputSchemaComplexEnumconvert_appcpuCPURequirementCreateFileRequirementCWLdata_formatdata_subtypedata_typeDatatypeEnumdays_to_deathdeletedisease_typedockerDockerRequirementdownloadDSCListenumEnvironmentDefEnvironmentDefListEnvVarRequirementethnicityexperimental_strategyExpressionExpressionEngineRequirementExpressionToolFilefile_extensionfile_segment_numberfileDefFileDefFileDefListFileListFilesFilesListFlowFSgdc_file_uuidgenderget_cwl_classget_tokenget_uploadergetTaskHookInParinputinput_matrixInputParameterInputParameterListInputSchemainvestigationIPListis_commandlinetoolis_workflowItemArraylibrary_idlinklink_whatmemMemRequirementMetadatamisc_get_tokenmisc_get_uploadermisc_make_metadatamisc_upload_cliOPListOutParoutputoutput_matrixOutputParameterOutputParameterListOutputSchemapaired_endParameterplatformplatform_unit_idprimary_sitePrimitiveEnumProcessProcessRequirementProcessRequirementListproject_detailsproject_membersquality_scaleracereference_genomerequirementsresponseresponse<-sample_idsample_typesample_uuidsbg_get_envsbg_set_envSBGWorkflowScatterFeatureRequirementSchemaSchemaDefSchemaDefListSchemaListset_tagset_test_envsetTaskHookSubworkflowFeatureRequirementtest_tool_bunnytest_tool_cwlruntest_tool_rabixToolupload_complete_allupload_complete_partupload_deleteupload_infoupload_info_partupload_initvital_statusWorkflowWorkflowOutputParameterWorkflowOutputParameterListWorkflowStepWorkflowStepInputWorkflowStepInputListWorkflowStepListWorkflowStepOutputWorkflowStepOutputList

Dependencies:askpassBiocGenericsclicurldata.tabledocoptgenericsgluehttrjsonlitelifecyclemagrittrmimeobjectPropertiesobjectSignalsopensslR6rlangS4Vectorsstringistringrsysuuidvctrsyaml

Complete Guide for Seven Bridges API R Client
Introduction | R Client for Seven Bridges API | API General Information | Installation | Quickstart | Create Auth Object | Get User Information | Rate Limit | Show Billing Information | Create Project | Get Details about Existing Project | Copy Public Apps into Your Project | Import CWL App and Run a Task | Execute a New Task | Find your app inputs | Get your input files ready | Create a new draft task | Draft a batch task | Run a Task | Run tasks using spot instances | Execution hints per task run | Task Monitoring | Seven Bridges API Reference | Authentication | Direct authentication | Authentication via system environment variables | Authentication via user configuration file | List All API Calls | Offset, Limit, Search, and Advance Access Features | offset and limit | Search by ID | Search by name | Experiment with Advance Access features | Query Parameter 'fields' | Rate Limits | Users | Billing Group and Invoices | For billing | For invoices | Project | List all projects | Partial match project name | Filter by project creation date, modification date, and creator | Create a new project | Create a new project with TCGA controlled data on CGC | Delete a project | Update/edit a project | Project member | List members | Add a member | Update a member | Delete a member | List all files | Files, Metadata, and Tags | Search and filter file(s) | Rule of thumb | Search by name and id | Search by metadata | Search by tags | Search by original task id | Copy a file or group of files | Delete file(s) | Download files | Upload files via API | Upload single file | Upload a folder | Upload a list of files | Upload files via a defined manifest file | Upload files via command line uploader | Update a file | Metadata operations | Tag file(s) | Folders | Get project root folder | Create a folder | Copy files between folders | Move files between folders | List folder contents | Get file and folder details | Delete files in a folder | Delete a folder | Apps | List all apps | Copy an app | Get an app's CWL description | Add CWL as an app | Describe CWL in R directly | Create test or keep the previous test for Tool | Tasks | List tasks | Create a draft task | Modify a task | Run a task | Abort a running task | Delete a task | Download all files from a completed task | Run tasks in batch mode | Download all files from a batch task | Volumes | Create a volume | List and search all volumes | Get a volume's detail | Delete volume | Import file from volume to project | Export file from project to volume | Public Files and Apps | Public files | Public apps | Actions | Copy files between projects | Send a feedback item | Enterprise | API token for the division context | List all divisions | Get details of a division | Create a team | Get details of a team | Add a team member | List team members | Remove a team member | Rename a team | List your teams in the division | Delete a team | Markers | Create a marker | List markers available on a file | Get details for a marker | Modify a marker | Delete a marker | Get Raw Response from httr | Batch Operation on Project/Files/Tasks | API Cheatsheet

Last update: 2020-10-15
Started: 2016-03-31

Describe and Execute CWL Tools/Workflows in R
Prerequisite | Apps, Workflows, and Tools | Describe Tools in R | Import from JSON file | Utilitites for Tool object | Create your own tool in R | Introduction | Using existing Docker images and command | Add customized script to existing Docker image | Create formal interface for your command line | Quick command line interface with commandArgs (position and named args) | docopt: a better and formal way to make command line interface | Generate reports | Misc | Describe Wokrflow in R | Import from a JSON file | Utilities for Flow objects | Create your own flow in R | Connect simple linear tools | Connecting tools by input and output id | Connecting tool with workflow by input and output id | Using pipe to construct complicated workflow | Execution | Execute the tool and flow in the cloud | Execute the tool in Rabix -- test locally

Last update: 2020-06-03
Started: 2016-01-22

Creating Your Docker Container and Command Line Interface (with docopt)
Introduction | Existing Docker repos | Rocker Project | Bioconductor Images | Docker Hub | Seven Bridges Docker Registry | Tutorial: Random Number Generator | Using docopt Package | Quick Command Line Interface with commandArgs (Position and Named Args) | Quick Report: Spin and Stich | Executable Report with R Markdown (Advanced) | Setup Docker Hub Automated Build | More Examples

Last update: 2020-03-26
Started: 2016-01-22

Find Data on CGC via Data Browser and Datasets API
Introdution | Graphical Data Browser | Datasets API | Browse TCGA via the Datasets API | Return datasets accessible trough the CGC | Return list of all TCGA entities | Interpreting the list of all entities | Copy files to you project | Post with query | Find samples connected to a case | Find cases with given age at diagnosis | Find cases with a given age at diagnosis and disease | Complex example for filtering TCGA data | Query with multiple filters on a case

Last update: 2020-03-26
Started: 2018-11-15

IDE Container: RStudio Server, Shiny Server, and More
Introduction | Docker container | Build container locally | Pull from Docker Hub | Launch RStudio Server from Docker container | Launch both RStudio Server and Shiny Server from the same Docker container

Last update: 2020-03-26
Started: 2016-02-09

Master Tutorial: Use R for Cancer Genomics Cloud
Introduction | Prerequisites | Installation | Register on Cancer Genomics Cloud | Authentication | Register on shinyapps.io (Optional) | Report issues | Quickstart | Create a project under your account via API R client | Build a RNA-Seq tool: from bam to report | Step 1: Have a plan | Step 2: Create Docker container for your tool | Step 3: Create your command line interface | Step 4: Add default report template to your app | Step 5: Describe your tool in R into CWL | Step 6: Execute your tool with a new task via R API | Build a reporting Tool | What is report tool? | Compose a full workflow | Exercise: bring your own tool | More tutorials

Last update: 2020-03-26
Started: 2016-02-09

Readme and manuals

Help Manual

Help pageTopics
Seven Bridges Platform API Client and CWL Tool Builder in Rsevenbridges-package
add '#' prefix to idaddIdNum
Core HTTP logic for Seven Bridges APIapi
Class AppApp App-class
Convert a object slots/fields to a list, json, or yaml fileasList asList,ANY-method asList,CWL-method asList,DSCList-method asList,SimpleList-method asList,SingleEnum-method
Class AuthAuth Auth-class
batch function for task batch executionbatch
BindingBinding Binding-class
characterORCommandLineBindingList ClassCCBList characterORCommandLineBindingList-class
Shorthand functions for cwl packages constructorsargslist CLB COB InPar input IPList OPList OutPar output
List projects using Seven Bridges command line uploadercli_list_projects
List all the tags in project using Seven Bridges command line uploadercli_list_tags
Upload files using Seven Bridges command line uploadercli_upload misc_upload_cli
CommandInputParameter ClassCommandInputParameter CommandInputParameter-class
CommandInputSchema ClassCommandInputSchema CommandInputSchema-class
CommandLineBinding ClassCommandLineBinding CommandLineBinding-class
CommandLineTool ClassCommandLineTool CommandLineTool-class
CommandOutputBinding ClassCommandOutputBinding CommandOutputBinding-class
CommandOutputParameter ClassCommandOutputParameter CommandOutputParameter-class
CommandOutputSchemaCommandOutputSchema CommandOutputSchema-class
Convert App or a CWL JSON file to Tool or Flow objectappType convert_app
Rabix specifc RequirementsanyReq AnyRequirement AnyRequirement-class aws AWSInstanceTypeRequirement AWSInstanceTypeRequirement-class cpu CPURequirement CPURequirement-class docker fileDef mem MemRequirement MemRequirement-class requirements
Class CWLCWL CWL-class
Delete files or foldersdelete delete,Files-method delete,SimpleList-method delete,Task-method
Download filesdownload download,Files-method download,FilesList-method
DSC listDSCList DSCList-class
Expression ClassExpression Expression-class
ExpressionTool ClassExpressionTool ExpressionTool-class
FileList ClassFile File-class FileList FileList-class
Class FilesFiles Files-class FilesList FilesList-class
FS classFS FS-class
Get class from CWL JSON fileget_cwl_class is_commandlinetool is_workflow
Opens web browser to copy the auth tokenget_token misc_get_token
Download Seven Bridges command line uploader and extract to a specified directoryget_uploader misc_get_uploader
Handler instanceHandler Handler-class
Get input/output matrix out of JSON CWL file directlyinput_matrix output_matrix
Class ItemItem Item-class
link two nodes to form a new Workflowlink link,App,ToolORWorkflow-method link,Tool,Tool-method link,Tool,Workflow-method link,ToolORWorkflow,App-method link,Workflow,Tool-method link,Workflow,Workflow-method
List possible linking methodslink_what link_what,SBGWorkflow,SBGWorkflow-method link_what,SBGWorkflow,Tool-method link_what,Tool,SBGWorkflow-method link_what,Tool,Tool-method
Meta schemaaccess_level age_at_diagnosis aliquot_id aliquot_uuid analysis_uuid case_id case_uuid data_format data_subtype data_type days_to_death disease_type ethnicity experimental_strategy file_extension file_segment_number gdc_file_uuid gender investigation library_id Metadata Metadata-class misc_make_metadata paired_end platform platform_unit_id primary_site quality_scale race reference_genome sample_id sample_type sample_uuid vital_status
Paramter class (reference class)InputParameter InputParameter-class InputParameterList InputParameterList-class OutputParameter OutputParameter-class OutputParameterList OutputParameterList-class Parameter Parameter-class
Pre-defiend enumsComplexEnum ComplexSingleEnum-class DatatypeEnum DatatypeSingleEnum-class enum enum-class ItemArray ItemArray-class PrimitiveEnum PrimitiveSingleEnum-class
Process ClassProcess Process-class
ProcessRequirement ClassCreateFileRequirement CreateFileRequirement-class DockerRequirement DockerRequirement-class EnvironmentDef EnvironmentDef-class EnvironmentDefList EnvironmentDefList-class EnvVarRequirement EnvVarRequirement-class ExpressionEngineRequirement ExpressionEngineRequirement-class FileDef FileDef-class FileDefList FileDefList-class ProcessRequirement ProcessRequirement-class ProcessRequirementList ProcessRequirementList-class ScatterFeatureRequirement ScatterFeatureRequirement-class SubworkflowFeatureRequirement SubworkflowFeatureRequirement-class
Returns the details of the projectproject_details
Returns a list of all users invited to the project and their privilegesproject_members
Get raw response from an Item objectresponse response,ANY-method response,Item-method response,SimpleList-method response<- response<-,ANY-method response<-,Item-method response<-,SimpleList-method
Set authentication environment variables for Seven Bridges APIsbg_get_env
Set authentication environment variables for Seven Bridges APIsbg_set_env
Build workflow"%>>%" "%>>%",App,App-method "%>>%",Tool,Tool-method "%>>%",Workflow,App-method "%>>%",Workflow,Tool-method "%>>%",Workflow,Workflow-method "+",App,App-method "+",Tool,Tool-method "+",WorkflowStepList,App-method "+",WorkflowStepList,Tool-method "+",WorkflowStepList,WorkflowStepList-method %>>% %>>%,App,App-method %>>%,Tool,Tool-method %>>%,Workflow,App-method %>>%,Workflow,Tool-method %>>%,Workflow,Workflow-method +,App,App-method +,Tool,Tool-method +,WorkflowStepList,App-method +,WorkflowStepList,Tool-method +,WorkflowStepList,WorkflowStepList-method Flow SBGWorkflow SBGWorkflow-class
SchemaListInputSchema InputSchema-class OutputSchema OutputSchema-class ScehmaList Schema Schema-class SchemaDef SchemaDef-class SchemaDefList SchemaDefList-class SchemaList SchemaList-class
Set file tagsadd_tag add_tag,Files-method add_tag,FilesList-method set_tag set_tag,Files-method set_tag,FilesList-method
Set testing envset_test_env
List Class generator.setListClass
set task function hookgetTaskHook setTaskHook
Test tools in rabix/bunnytest_tool_bunny
Test tools with cwl-runnertest_tool_cwlrun
Test tools in rabix/rabix-devel (DEPRECATED)test_tool_rabix
Class ToolTool Tool-class
Reports the complete file uploadupload_complete_all
Reports the completion of the part uploadupload_complete_part
Abort the uploadupload_delete
Returns upload information for the ongoing uploadupload_info
Returns AWS S3 signed URL for a part of the file uploadupload_info_part
Initializes the upload of the specified fileupload_init
WorkflowWorkflow Workflow-class WorkflowOutputParameter WorkflowOutputParameter-class WorkflowOutputParameterList WorkflowOutputParameterList-class
WorkflowStepInputListWorkflowStep WorkflowStep-class WorkflowStepInput WorkflowStepInput-class WorkflowStepInputList WorkflowStepInputList-class WorkflowStepList WorkflowStepList-class WorkflowStepOutput WorkflowStepOutput-class WorkflowStepOutputList WorkflowStepOutputList-class