Learn R Programming

⚠️There's a newer version (1.0.7) of this package.Take me there.

tidycwl

Read, parse, and visualize Common Workflow Language (CWL) workflows.

The Common Workflow Language is an open standard for describing data analysis workflows. This package takes the raw Common Workflow Language workflows encoded in JSON or YAML and turns the workflow elements into tidy data frames or lists. A graph representation for the workflow can be constructed and visualized with the parsed workflow inputs, outputs, and steps. Users can embed the visualizations in their Shiny applications, and export them as HTML files or static images.

Check out the vignette for a quick introduction.

Installation

To download and install tidycwl from CRAN:

install.packages("tidycwl")

Or try the development version on GitHub:

# install.packages("remotes")
remotes::install_github("sbg/tidycwl")

Copyright

© 2020 Seven Bridges Genomics, Inc. All rights reserved.

This project is licensed under the GNU Affero General Public License v3.

Copy Link

Version

Install

install.packages('tidycwl')

Monthly Downloads

174

Version

1.0.6

License

AGPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Jeffrey Grover

Last Published

December 14th, 2021

Functions in tidycwl (1.0.6)

get_edges

Get edges in a CWL workflow into a data frame
get_nodes

Get nodes in a CWL workflow into a data frame
print.cwl

Print CWL objects
read_cwl

Read a CWL file into a list
read_cwl_yaml

Read a CWL file (YAML format) into a list
is_v1.1

Is this CWL v1.1?
parse_cwl

Parse a CWL workflow
is_v1.0

Is this CWL v1.0?
is_workflow

Is this a CWL workflow?
read_cwl_json

Read a CWL file (JSON format) into a list
get_steps_revision

Get revision number for steps
get_steps_label

Get label for steps
parse_type

Parse CWL content type
%>%

Pipe operator
is_draft2

Is this CWL draft2?
is_cwl

Is this a CWL object?
get_steps_version

Get toolkit version for steps
visualize_graph

Visualize the CWL workflow
is_tool

Is this a CWL command line tool?
parse_inputs

Parse the inputs of the CWL workflow into a data frame
get_inputs_id

Get ID for inputs
get_steps_id

Get ID for steps
get_steps_doc

Get documentation/description for steps
parse_meta

Parse the metadata in the CWL workflow
tidycwl_shiny

Shiny bindings for tidycwl
parse_steps

Parse the steps of the CWL workflow into a data frame
tidycwl-package

tidycwl: Tidy Common Workflow Language Tools and Workflows
parse_outputs

Parse the outputs of the CWL workflow into a data frame
get_outputs_label

Get label for outputs
get_inputs_label

Get label for inputs
get_cwl_version

Get CWL version
get_outputs_id

Get ID for outputs
get_graph

Get the CWL workflow graph
export_html

Export the workflow plot as HTML
export_image

Export the workflow plot as PNG, JPEG, or PDF files