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

Update documentation #334

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update documentation #334

wants to merge 4 commits into from

Conversation

imendes93
Copy link
Contributor

@imendes93 imendes93 commented Nov 24, 2022

Closes #328

This PR does an overhaul of the documentation for splicing-pipelines-nf, which now is divided into the following parts:

  • 1 - Pipeline description
    • 1.1 - Pipeline overview
    • 1.2 - Input
    • 1.3 - Default processes
    • 1.4 - Optional processes
    • 1.5 - Output
  • 2 - Options
  • 3 - Usage
    • 3.1 - Running with Docker or Singularity
    • 3.2 - Submitting run to CloudOS
    • 3.3 - Execution examples
  • 4 - Additional information
    • 4.1 - Quick start on Sumner
    • 4.2 - Additional documentation

@angarb
Copy link
Collaborator

angarb commented Dec 20, 2022

Hi @imendes93 - I think this is looking awesome! One thing that might be a mental leap for users is how to go from a 'Quick Test' to running the pipeline locally. https://github.com/TheJacksonLaboratory/splicing-pipelines-nf/blob/update-docs-238/docs/run_locally.md

This is something I do not know! Do you need to make a local folder with all of your docs? How do you specify your config in the nextflow run line? Maybe it would help to give an example of running real data and how parameters are specified (because we do this a bit differently on Sumner with the main.pbs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation to enable end users to easily execute the pipeline
3 participants