Skip to content
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

An example of running through the entire Snakemake workflow #30

Open
adam2392 opened this issue Jul 2, 2020 · 0 comments
Open

An example of running through the entire Snakemake workflow #30

adam2392 opened this issue Jul 2, 2020 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@adam2392
Copy link
Member

adam2392 commented Jul 2, 2020

Describe the problem

To provide documentation on how the entire workflow runs to go from .dcms to the output BIDS files and visualization engine, an example file is needed with screenshots where applicable.

Describe your solution

An example_workflow.rst file that sits in docs/ that walks through w/ an open-source set of dicoms.

Describe possible alternatives

Alternatively, rules.rst file that autodocs the Snakemake rule docstrings (idk how to do this though).

Additional context

See https://github.com/sequana/sequana which has some nice sphinx-gneerated docs from the snakemake rules. We can try to borrow the sphinx-ext code there.

@adam2392 adam2392 added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jul 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant