Skip to content

Update USE_EXISTING_DATA.md to latest test links, add reference to ot… #1654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update USE_EXISTING_DATA.md to latest test links, add reference to ot… #1654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/USE_EXISTING_DATA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested when adding a new test dataset.

- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) to find the branch corresponding to the test dataset you want to use
- [ ] Specify in the `conf/test.config` the path to the files from the test dataset
- [ ] Set up your CI tests following the nf-core best practices (cf [.github/workflows/ci.yml template](https://github.com/nf-core/tools/blob/dev/nf_core/pipeline-template/.github/workflows/ci.yml))
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) to find the branch corresponding to the test dataset you want to use (i.e., `modules`, or a given pipeline)
- [ ] Alternatively use nf-core tools to search and explore, e.g. `nf-core test-datasets list` (press tab for options), and then `nf-core test-datasets search -b modules fasta` (press tab for options)
- [ ] You can also use the flag `--generate-nf-path` to generate config ready strings
- [ ] Specify in the `conf/test.config` the path to the files from the test dataset
- [ ] Set up your CI tests following the nf-core best practices
- [ ] For pipelines: [tests/default.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/pipeline-template/tests/default.nf.test))
- [ ] For modules: [tests/main.nf.test](https://github.com/nf-core/tools/blob/main/nf_core/module-template/tests/main.nf.test.j2)