modify_workflow: Modifies an existing workflow

Description Usage Arguments Value Examples

Description

Your modifications will not affect any existing analyses or analysistemplates. A successfull modification will increase the version field of the workflow. You can update an analysistemplate through AnalysisApi: /api/v1/analysistemplates/id/update_workflow

Usage

1
modify_workflow(connection, path_to_workflow, workflow_id)

Arguments

connection

The connection to be used, call connect to obtain one.

path_to_workflow

The file path to the edit model JSON.

workflow_id

The id of the workflow to be updated

Value

A FGResponse object if no errors, otherwisea a FGErrorResponse

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
connection <- fastgenomicsRclient::connect("https://fastgenomics.org/", "Beaer ey...")
 # get a workflow as example
workflow <- fastgenomicsRclient::get_edit_model_of_workflow(connection, "wf_abc")
print(workflows@content) # the workflows as an easily usable model
path <- "workflow.json"
save_workflow_as_file(workflow, path) # save the workflow on disk
# make edits on the file...
result <- create_workflow(connection, path) # create the workflow
updated_workflow <- modify_workflow(connection, path, result@content[["id"]]) # update the workflow
print(updated_workflow@content[["version"]]) # should be 2.0

FASTGenomics/r_client documentation built on June 25, 2019, 12:12 a.m.