-
-
Notifications
You must be signed in to change notification settings - Fork 7
Paper #195
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ntachukwu
wants to merge
13
commits into
main
Choose a base branch
from
paper
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Paper #195
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
8737a73
initial draft for joss paper
ntachukwu a2c96c6
add reference to cwl-utils and fix typos in paper.md
ntachukwu efa1ad8
Merge branch 'main' into paper
ntachukwu 5904bb1
build the paper
mr-c c4e7e00
fix the bibliography
mr-c 3e8ab18
fix typos and improve paper.md
ntachukwu 751a27f
merge conflict with remote
ntachukwu 63d6aa6
fix tool benefit description
ntachukwu 7358cfa
fix typo in paper.md
ntachukwu 8a3cbe2
fix merge conflict
ntachukwu 458aed4
Update paper/paper.md
ntachukwu 645bd9b
Merge branch 'main' into paper
ntachukwu 9895486
update paper.md
ntachukwu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| on: [push] | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| # This should be the path to the paper within your repo. | ||
| paper-path: paper/paper.md | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v1 | ||
| with: | ||
| name: paper | ||
| # This is the output path where Pandoc will write the compiled | ||
| # PDF. Note, this should be the same directory as the input | ||
| # paper.md | ||
| path: paper/paper.pdf |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| @article{cwl, | ||
| Author = {Michael R. Crusoe and Sanne Abeln and Alexandru Iosup and Peter Amstutz and John Chilton and Nebojša Tijanić and Hervé Ménager and Stian Soiland-Reyes and Bogdan Gavrilovic and Carole Goble and The CWL Community}, | ||
| Title = {Methods Included: Standardizing Computational Reuse and Portability with the Common Workflow Language}, | ||
| Year = {2021}, | ||
| Eprint = {arXiv:2105.07028}, | ||
| Doi = {10.1145/3486897}, | ||
| } | ||
|
|
||
| @misc{wdl, | ||
| author = {WDL Community}, | ||
| title = {Workflow Description Language (WDL)}, | ||
| year = {2017}, | ||
| publisher = {GitHub}, | ||
| journal = {GitHub repository}, | ||
| url = {https://github.com/openwdl/wdl} | ||
| } | ||
|
|
||
| @misc{miniwdl, | ||
| author = {miniwdl Community}, | ||
| title = {miniwdl}, | ||
| year = {2018}, | ||
| publisher = {GitHub}, | ||
| journal = {GitHub repository}, | ||
| url = {https://github.com/chanzuckerberg/miniwdl/} | ||
| } | ||
|
|
||
| @misc{cwl_utils, | ||
| author = {CWL Community}, | ||
| title = {cwl-utils}, | ||
| year = {2019}, | ||
| publisher = {GitHub}, | ||
| journal = {GitHub repository}, | ||
| url = {https://github.com/common-workflow-language/cwl-utils} | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: 'wdl2cwl: A Python tool for converting WDL workflows to CWL' | ||
| tags: | ||
| - Python | ||
| - workflow | ||
| - workflow description language | ||
| - common workflow language | ||
| authors: | ||
| - name: Dinithi Wickramaratne | ||
| - name: Dennis Chukwunta | ||
| - name: Michael R. Crusoe | ||
| orcid: 0000-0002-2961-9670 | ||
| - name: Bruno P. Kinoshita | ||
| orcid: 0000-0001-8250-4074 | ||
| - name: Peter Amstutz | ||
| orcid: 0000-0003-3566-7705 | ||
| date: August 2022 | ||
| bibliography: paper.bib | ||
| --- | ||
|
|
||
| # Summary | ||
|
|
||
| Computational workflows are used in data analysis, enabling innovation and | ||
| decision-making in various fields of science. There are several competing workflow description systems, | ||
| WDL (Workflow description Language) and CWL (Common Workflow Language) are two examples | ||
| of popularly used systems. WDL offers a way to specify data processiing workflows with | ||
| a human-readable and writeable syntax. WDL makes it straightforward to define | ||
| complex analysis tasks, chain them together in workflows, and parallelize their execution [@wdl]. | ||
| CWL on the other hand, is a way to describe command line tools and connect | ||
| them together to create workflows. Because CWL is a specification and not a | ||
| specific piece of software, tools and workflows described using CWL are portable across | ||
| a variety of platforms that support the CWL standard [@cwl]. | ||
|
|
||
| Groups using WDL or CWL can find it difficult to learn the other workflow definition | ||
| language if they need to run their workflows in other platforms. It becomes even harder | ||
| when the workflows contain domain specific knowledge mixed with the definitions, and | ||
| when analysts and scientists need to consider future collaboration of other groups on | ||
| the workflows definitions. | ||
|
|
||
| ``wdl2cwl`` is a Python package for converting workflow written in WDL to workflows in CWL. | ||
| The ``wdl2cwl`` package uses the ``miniwdl`` package [@miniwdl], an open source, Python package, | ||
| developer toolkit and local runner for running WDL files. The ``wdl2cwl`` package was | ||
| designed to provide a class-based and developer-friendly interface for extracting | ||
| the various sections of a WDL file, dynamically create the various objects | ||
| needed to create a valid CWL file ( this is done using the ``cwl-utils`` package [@cwl_utils], | ||
ntachukwu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| an open source, Python package for parsing CWL files) and performing error checking | ||
| for valid imports, input declarations, expressions and other useful operations on CWL files. | ||
|
|
||
| ``wdl2cwl`` was designed to be used by both CWL/WDL professionals and researchers, as well | ||
| as students of bioinformatics and data analytics. It can help CWL analysts to avoid | ||
| platform dependency issues (like trying to reproduce a WDL workflow on a platform that | ||
| only allows CWL). It can help analysts by eliminating the difficulty of learning a new | ||
| workflow language before they an use a WDL worflow. It can be used to create a more | ||
| widely available workflow that can be used by analysts of either languages. | ||
ntachukwu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| # Acknowledgements | ||
|
|
||
| We acknowledge the work by the developers of miniwdl, CWL and WDL. | ||
ntachukwu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| # References | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.