Skip to content
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.

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

feat(modules_testdata_base_path): update guidelines for test data #2474

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

maxulysse
Copy link
Member

@maxulysse maxulysse commented Apr 26, 2024

@netlify /docs/contributing/test_data_guidelines

@maxulysse maxulysse requested a review from a team as a code owner April 26, 2024 08:15
@maxulysse maxulysse requested a review from jfy133 April 26, 2024 08:15
Copy link

netlify bot commented Apr 26, 2024

Deploy Preview for nf-core ready!

Name Link
🔨 Latest commit 907adc0
🔍 Latest deploy log https://app.netlify.com/sites/nf-core/deploys/662b6992d800b6000814b023
😎 Deploy Preview https://deploy-preview-2474--nf-core.netlify.app/docs/contributing/test_data_guidelines
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Co-authored-by: James A. Fellows Yates <[email protected]>
@@ -57,10 +57,10 @@ In contrast, if your module requires many tests, steps, or heavy CPU usage, you

11. The test data pull request requires a review to be merged.

12. Once you've had your pull request merged in into `nf-core/test-datasets`, make another PR into [nf-core/modules](https://github.com/nf-core/modules), to add your file as a new entry to the [`modules/tests/config/test_data.config`](https://github.com/nf-core/modules/blob/master/tests/config/test_data.config).
12. Once you've had your pull request merged in into `nf-core/test-datasets`, you are good to go and you can use refer to the newly uploaded file(s) for your test(s). Use `params.modules_testdata_base_path` to point to the test data directory in your module, and append to it the path to the file(s) you need. an example using the `fasta` file from `sarscov2`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
12. Once you've had your pull request merged in into `nf-core/test-datasets`, you are good to go and you can use refer to the newly uploaded file(s) for your test(s). Use `params.modules_testdata_base_path` to point to the test data directory in your module, and append to it the path to the file(s) you need. an example using the `fasta` file from `sarscov2`:
12. Once you've had your pull request merged in into `nf-core/test-datasets`, you are good to go and you can refer to the newly uploaded file(s) for your test(s). Use `params.modules_testdata_base_path` to point to the test data directory in your module, and append to it the path to the file(s) you need. an example using the `fasta` file from `sarscov2`:


- This only applies field-specific collections, `delete_me/` files are excluded from this, and raw github URLs should be used in tests.
- The 'key' for each URL should follow the style of the full file name with extensions but with underscores rather than full-stops e.g. `genome.fa.gz` would become `genome_fa_gz`.
- `file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)`
```groovy
file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)
```

- This only applies field-specific collections, `delete_me/` files are excluded from this, and raw github URLs should be used in tests.
- The 'key' for each URL should follow the style of the full file name with extensions but with underscores rather than full-stops e.g. `genome.fa.gz` would become `genome_fa_gz`.
- `file(params.modules_testdata_base_path + 'genomics/sarscov2/genome/genome.fasta', checkIfExists: true)`
- Note the file string corresponds to the directory structure of the modules repository.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Note the file string corresponds to the directory structure of the modules repository.
Note that the file string corresponds to the directory structure of the modules repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants