search

signaturescience / metscale

MetScale: snakemake workflows to scale metagenome analyses
BSD 3-Clause "New" or "Revised" License
18 stars 9 forks source link

example_workflowsettings.json should be replaced with the one in the wiki #13

Closed lovettse closed 5 years ago

lovettse commented 5 years ago

The text in the "Workflow Architecture" section of the wiki would serve as a better example workflow than the one given.

kternus commented 5 years ago

That's good feedback, thanks for sharing that you liked the custom config file on the "Workflow Architecture" page better than the default configs referenced on the other wiki pages. We'll adjust our documentation to center around that as the primary example in the future. It is nice to run everything at once with a single custom config.json, and you can save that json file with a unique name to more easily find and reference later.

kternus commented 5 years ago

In v1.2, we added the following two example custom config files for users to edit and save to run with their own samples:

https://github.com/signaturescience/metagenomics/blob/master/workflows/config/my_custom_config.json

https://github.com/signaturescience/metagenomics/blob/master/workflows/config/illumina_custom_config.json

We also included additional information about the custom config files in the wiki documentation, but the main idea was to provide users with an easier way to use an example custom config upfront.

Hope that helps!