Repository navigation
Eupathpopgen #2278
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
Merged
Merged
Eupathpopgen #2278
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2416620
Add eupathpopgen test data shared from plasmodiumdrugres.
kathrynmurie 2520445
remove unnecessary info
kathrynmurie 2a8a950
Add example pmo
kathrynmurie 2191ad5
Add extra info about files to README
kathrynmurie 4573e48
Fix readme format
kathrynmurie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,39 +1,17 @@ | ||
| #  | ||
| # test-datasets: `eupathpopgen` | ||
|
|
||
| Test data to be used for automated testing with the nf-core pipelines | ||
| This branch contains test data for automated testing with the [nf-core/eupathpopgen](https://github.com/nf-core/eupathpopgen) pipeline. | ||
|
|
||
| > ⚠️ **Do not merge your test data to `master`! Each pipeline has a dedicated branch (and a special one for modules)** | ||
| ## Content of this repository | ||
|
|
||
| ## Introduction | ||
| All files are located under `testdata/`. The allele table and PMO examples represent the same dataset in different formats. | ||
|
|
||
| nf-core is a collection of high quality Nextflow pipelines. This repository contains various files for CI and unit testing of nf-core pipelines and infrastructure. | ||
| The data were simulated using [recombuddy](https://github.com/PlasmoGenEpi/recombuddy) from a background population derived from publicly available whole-genome sequencing data from Southeast Asia (SEA). The simulated parasite genomes were then processed in silico using the MAD4HaTteR targeted sequencing panel to generate realistic targeted-sequencing FASTQ files. These FASTQ files were subsequently processed using the SeekDeep pipeline. | ||
|
|
||
| The principle for nf-core test data is as small as possible, as large as necessary. Please see the [guidelines](https://nf-co.re/docs/contributing/test_data_guidelines) for more detailed information. Always ask for guidance on the [nf-core slack](https://nf-co.re/join) before adding new test data. | ||
| The PMO file also contains synthetic sample metadata. | ||
|
|
||
| ## Documentation | ||
| ### Pipeline inputs | ||
|
|
||
| nf-core/test-datasets comes with documentation in the `docs/` directory: | ||
|
|
||
| 1. [Add a new test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/ADD_NEW_DATA.md) | ||
| 2. [Use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md) | ||
|
|
||
| ## Downloading test data | ||
|
|
||
| Due the large number of large files in this repository for each pipeline, we highly recommend cloning only the branches you would use. | ||
|
|
||
| ```bash | ||
| git clone <url> --single-branch --branch <pipeline/modules/branch_name> | ||
| ``` | ||
|
|
||
| To subsequently clone other branches[^1] | ||
|
|
||
| ```bash | ||
| git remote set-branches --add origin [remote-branch] | ||
| git fetch | ||
| ``` | ||
|
|
||
| ## Support | ||
|
|
||
| For further information or help, don't hesitate to get in touch on our [Slack organisation](https://nf-co.re/join/slack) (a tool for instant messaging). | ||
|
|
||
| [^1]: From [stackoverflow](https://stackoverflow.com/a/60846265/11502856) | ||
| - `testdata/allele_table.tsv`: Microhaplotype allele table (`specimen_name`, `target_name`, `reads`, `seq`, plus optional `bioinformatics_run_name` / `allele` columns from the drugres extract). | ||
| - `testdata/population_assignment.tsv`: Specimen-to-population map (`specimen_name`, `population`) for optional `--population_map` runs. | ||
| - `testdata/example_PMO.json`: Example Portable Microhaplotype Object for `--pmo` / `-profile test_pmo`. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is rather minimal, I highly recommend you provide more information/detailed description of where the files came from/how they were generated - can be useful if files/got history gets corrupted etc