generated from snakemake-workflows/snakemake-workflow-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,15 @@ | ||
| # Snakemake workflow: `<name>` | ||
| # Snakemake workflow: `cut_and_run` | ||
|
|
||
| [](https://snakemake.github.io) | ||
| [](https://github.com/<owner>/<repo>/actions?query=branch%3Amain+workflow%3ATests) | ||
| [](https://github.com/niekwit/cut_and_run/actions?query=branch%3Amain+workflow%3ATests) | ||
|
|
||
|
|
||
| A Snakemake workflow for `<description>` | ||
| A Snakemake workflow for `Cut & Run seq` | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| The usage of this workflow is described in the [Snakemake Workflow Catalog](https://snakemake.github.io/snakemake-workflow-catalog/?usage=<owner>%2F<repo>). | ||
| The usage of this workflow is described in the [Snakemake Workflow Catalog](https://snakemake.github.io/snakemake-workflow-catalog/?usage=niekwit%2Fcut_and_run). | ||
|
|
||
| If you use this workflow in a paper, don't forget to give credits to the authors by citing the URL of this (original) <repo>sitory and its DOI (see above). | ||
| If you use this workflow in a paper, don't forget to give credits to the authors by citing the URL of this (original) repository 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. | ||
| * Replace `<name>` with the workflow name (can be the same as `<repo>`). | ||
| * Replace `<description>` with a description of what the workflow does. | ||
| * 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. |