TheJacksonLaboratory / splicing-pipelines-nf

Repository for the Anczukow-Lab splicing pipeline
14 stars 9 forks source link

Update documentation #334

Open imendes93 opened 1 year ago

imendes93 commented 1 year ago

Closes #328

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

angarb commented 1 year ago

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).