Skip to content

MPUSP/snakemake-simple-mapping

Repository files navigation

Snakemake-simple-mapping

Snakemake GitHub actions status run with conda workflow catalog

A Snakemake workflow for the mapping of reads to reference genomes, minimalistic and simple. This workflow tries to be agnostic regarding the target organism, type of read input (single end or paired end, short or long), and basically anything else. You can use it for viruses, bacteria, or eukaryotes. This simplicity comes at the cost that not every circumstance is covered (special reads, UMIs, you name it), but it will probably get the job done in most use cases.

Usage

The usage of this workflow is described in the Snakemake Workflow Catalog.

Detailed information about input data and workflow configuration can also be found in the config/README.md.

If you use this workflow in a paper, don't forget to give credits to the authors by citing the URL of this repository or its DOI.

Workflow overview:

Deployment options

To run the workflow from command line, change the working directory.

cd path/to/snakemake-simple-mapping

Adjust options in the default config file config/config.yml. Before running the complete workflow, you can perform a dry run using:

snakemake --dry-run

To run the workflow with test files using conda:

snakemake --cores 2 --sdm conda --directory .test

Authors

References

Köster, J., Mölder, F., Jablonski, K. P., Letcher, B., Hall, M. B., Tomkins-Tinch, C. H., Sochat, V., Forster, J., Lee, S., Twardziok, S. O., Kanitz, A., Wilm, A., Holtgrewe, M., Rahmann, S., & Nahnsen, S. Sustainable data analysis with Snakemake. F1000Research, 10:33, 10, 33, 2021. https://doi.org/10.12688/f1000research.29032.2.

About

A Snakemake workflow for the mapping of reads to reference genomes, minimalistic and simple.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages