Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 1.65 KB

README.md

File metadata and controls

21 lines (11 loc) · 1.65 KB

Snakemake workflow: Kingfisher_workflow

Snakemake GitHub actions status

A Snakemake workflow for downloading whole projects together with their metadata using kingfisher-download. It extends its functionality by making possible to download samples from the same BioProject in parallel. Additionally, it merges runs coming from one sample together, to make further analysis easier.

Usage

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

Since kingfisher-download is not available on conda, you need to install and configure it before running this workflow. Moreover, you need to install snakemake.

If you use this workflow in a paper, don't forget to give credits to the authors by citing the URL of this (original) sitory and its DOI (see above).

TODO

  • Replace <owner> and <repo> everywhere in the template (also under .github/workflows) with the correct <repo> name and owning user or organization.
  • The workflow will occur in the snakemake-workflow-catalog once it has been made public. Then the link under "Usage" will point to the usage instructions if <owner> and <repo> were correctly set.