Package: sevenbridges 1.37.0
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:
sevenbridges_1.37.0.tar.gz
sevenbridges_1.37.0.zip(r-4.5)sevenbridges_1.37.0.zip(r-4.4)sevenbridges_1.37.0.zip(r-4.3)
sevenbridges_1.37.0.tgz(r-4.4-any)sevenbridges_1.37.0.tgz(r-4.3-any)
sevenbridges_1.37.0.tar.gz(r-4.5-noble)sevenbridges_1.37.0.tar.gz(r-4.4-noble)
sevenbridges_1.37.0.tgz(r-4.4-emscripten)sevenbridges_1.37.0.tgz(r-4.3-emscripten)
sevenbridges.pdf |sevenbridges.html✨
sevenbridges/json (API)
NEWS
# 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:https://sbg.github.io
On BioConductor:sevenbridges-1.37.0(bioc 3.21)sevenbridges-1.36.0(bioc 3.20)
softwaredataimportthirdpartyclientapi-clientbioconductorbioinformaticscloudcommon-workflow-languagesevenbridges
Last updated 2 months agofrom:265369eecd. Checks:OK: 3 NOTE: 4. Indexed: yes.
Target | Result | Date |
---|---|---|
Doc / Vignettes | OK | Nov 30 2024 |
R-4.5-win | NOTE | Nov 30 2024 |
R-4.5-linux | NOTE | Nov 30 2024 |
R-4.4-win | NOTE | Nov 30 2024 |
R-4.4-mac | NOTE | Nov 30 2024 |
R-4.3-win | OK | Nov 30 2024 |
R-4.3-mac | OK | Nov 30 2024 |
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
Rendered fromapi.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-10-15
Started: 2016-03-31
Creating Your Docker Container and Command Line Interface (with docopt)
Rendered fromdocker.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-03-26
Started: 2016-01-22
Describe and Execute CWL Tools/Workflows in R
Rendered fromapps.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-06-03
Started: 2016-01-22
Find Data on CGC via Data Browser and Datasets API
Rendered fromcgc-datasets.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-03-26
Started: 2018-11-15
IDE Container: RStudio Server, Shiny Server, and More
Rendered fromrstudio.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-03-26
Started: 2016-02-09
Master Tutorial: Use R for Cancer Genomics Cloud
Rendered frombioc-workflow.Rmd
usingknitr::rmarkdown
on Nov 30 2024.Last update: 2020-03-26
Started: 2016-02-09
Readme and manuals
Help Manual
Help page | Topics |
---|---|
Seven Bridges Platform API Client and CWL Tool Builder in R | sevenbridges-package |
add '#' prefix to id | addIdNum |
Core HTTP logic for Seven Bridges API | api |
Class App | App App-class |
Convert a object slots/fields to a list, json, or yaml file | asList asList,ANY-method asList,CWL-method asList,DSCList-method asList,SimpleList-method asList,SingleEnum-method |
Class Auth | Auth Auth-class |
batch function for task batch execution | batch |
Binding | Binding Binding-class |
characterORCommandLineBindingList Class | CCBList characterORCommandLineBindingList-class |
Shorthand functions for cwl packages constructors | argslist CLB COB InPar input IPList OPList OutPar output |
List projects using Seven Bridges command line uploader | cli_list_projects |
List all the tags in project using Seven Bridges command line uploader | cli_list_tags |
Upload files using Seven Bridges command line uploader | cli_upload misc_upload_cli |
CommandInputParameter Class | CommandInputParameter CommandInputParameter-class |
CommandInputSchema Class | CommandInputSchema CommandInputSchema-class |
CommandLineBinding Class | CommandLineBinding CommandLineBinding-class |
CommandLineTool Class | CommandLineTool CommandLineTool-class |
CommandOutputBinding Class | CommandOutputBinding CommandOutputBinding-class |
CommandOutputParameter Class | CommandOutputParameter CommandOutputParameter-class |
CommandOutputSchema | CommandOutputSchema CommandOutputSchema-class |
Convert App or a CWL JSON file to Tool or Flow object | appType convert_app |
Rabix specifc Requirements | anyReq AnyRequirement AnyRequirement-class aws AWSInstanceTypeRequirement AWSInstanceTypeRequirement-class cpu CPURequirement CPURequirement-class docker fileDef mem MemRequirement MemRequirement-class requirements |
Class CWL | CWL CWL-class |
Delete files or folders | delete delete,Files-method delete,SimpleList-method delete,Task-method |
Download files | download download,Files-method download,FilesList-method |
DSC list | DSCList DSCList-class |
Expression Class | Expression Expression-class |
ExpressionTool Class | ExpressionTool ExpressionTool-class |
FileList Class | File File-class FileList FileList-class |
Class Files | Files Files-class FilesList FilesList-class |
FS class | FS FS-class |
Get class from CWL JSON file | get_cwl_class is_commandlinetool is_workflow |
Opens web browser to copy the auth token | get_token misc_get_token |
Download Seven Bridges command line uploader and extract to a specified directory | get_uploader misc_get_uploader |
Handler instance | Handler Handler-class |
Get input/output matrix out of JSON CWL file directly | input_matrix output_matrix |
Class Item | Item Item-class |
link two nodes to form a new Workflow | link 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 methods | link_what link_what,SBGWorkflow,SBGWorkflow-method link_what,SBGWorkflow,Tool-method link_what,Tool,SBGWorkflow-method link_what,Tool,Tool-method |
Meta schema | access_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 enums | ComplexEnum ComplexSingleEnum-class DatatypeEnum DatatypeSingleEnum-class enum enum-class ItemArray ItemArray-class PrimitiveEnum PrimitiveSingleEnum-class |
Process Class | Process Process-class |
ProcessRequirement Class | CreateFileRequirement 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 project | project_details |
Returns a list of all users invited to the project and their privileges | project_members |
Get raw response from an Item object | response 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 API | sbg_get_env |
Set authentication environment variables for Seven Bridges API | sbg_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 |
SchemaList | InputSchema InputSchema-class OutputSchema OutputSchema-class ScehmaList Schema Schema-class SchemaDef SchemaDef-class SchemaDefList SchemaDefList-class SchemaList SchemaList-class |
Set file tags | add_tag add_tag,Files-method add_tag,FilesList-method set_tag set_tag,Files-method set_tag,FilesList-method |
Set testing env | set_test_env |
List Class generator. | setListClass |
set task function hook | getTaskHook setTaskHook |
Test tools in rabix/bunny | test_tool_bunny |
Test tools with cwl-runner | test_tool_cwlrun |
Test tools in rabix/rabix-devel (DEPRECATED) | test_tool_rabix |
Class Tool | Tool Tool-class |
Reports the complete file upload | upload_complete_all |
Reports the completion of the part upload | upload_complete_part |
Abort the upload | upload_delete |
Returns upload information for the ongoing upload | upload_info |
Returns AWS S3 signed URL for a part of the file upload | upload_info_part |
Initializes the upload of the specified file | upload_init |
Workflow | Workflow Workflow-class WorkflowOutputParameter WorkflowOutputParameter-class WorkflowOutputParameterList WorkflowOutputParameterList-class |
WorkflowStepInputList | WorkflowStep WorkflowStep-class WorkflowStepInput WorkflowStepInput-class WorkflowStepInputList WorkflowStepInputList-class WorkflowStepList WorkflowStepList-class WorkflowStepOutput WorkflowStepOutput-class WorkflowStepOutputList WorkflowStepOutputList-class |