You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/nf-core/assesspool/actions/workflows/ci.yml)
9
-
[](https://github.com/nf-core/assesspool/actions/workflows/linting.yml)[](https://nf-co.re/assesspool/results)[](https://doi.org/10.5281/zenodo.XXXXXXX)
[](https://docs.conda.io/en/latest/)
15
-
[](https://www.docker.com/)
16
-
[](https://sylabs.io/docs/)
17
-
[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/assesspool)
18
-
19
-
[](https://nfcore.slack.com/channels/assesspool)[](https://bsky.app/profile/nf-co.re)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)
20
6
21
7
## Introduction
22
8
23
-
**nf-core/assesspool** is a bioinformatics pipeline that ...
24
-
25
-
<!-- TODO nf-core:
26
-
Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the
27
-
major pipeline sections and the types of output it produces. You're giving an overview to someone new
28
-
to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction
29
-
-->
9
+
**assessPool** is a population genetics analysis pipeline designed for pooled sequencing runs (pool-seq). Starting from raw genomic variants (VCF or sync format), assessPool performs the following operations:
10
+
11
+
* Filters SNPs based on adjustable criteria with suggestions for pooled data
12
+
* Calculates population genetic statistics using [PoPoolation2](https://sourceforge.net/p/popoolation2/wiki/Main/), [poolfstat](https://doi.org/10.1111/1755-0998.13557), and/or [grenedalf](https://github.com/lczech/grenedalf).
13
+
* Generates an HTML report including visualizations of population genetic statistics
14
+
* Outputs results in tabular format for downstream analyses
15
+
16
+
Required inputs are a variant description file (sync or VCF) and a reference assembly (FASTA). These can be output from any number of reduced representation data processing pipelines (e.g., [grenepipe](https://github.com/moiexpositoalonsolab/grenepipe), [dDocent](https://ddocent.com/), etc.).
17
+
18
+
Major pipeline operations:
19
+
20
+
1. Import, index, and/or compress variant description and reference
21
+
1. Perform stepwise filtering to determine effects of individual filter options (count lost loci):
22
+
1. Min/max read depth
23
+
1. Minor allele count
24
+
1. Hardy-Weinberg equilibrium cutoff
25
+
1. Missing data
26
+
1. Allele length
27
+
1. Quality:depth ratio
28
+
1. Minimum read quality
29
+
1. Variant type
30
+
1. Mispaired read likelihood
31
+
1. Alternate observations
32
+
1. Mapping quality
33
+
1. Mapping ratio
34
+
1. Overall depth
35
+
1. Number of pools with data
36
+
1. Read balance
37
+
1. Variant thinning
38
+
1. Perform cumulative filtering (for VCF input)
39
+
1. Generate sync files
40
+
1. Unified (all pools)
41
+
1. Split pairwise
42
+
1. Generate allele frequency table
43
+
1. Calculate F<sub>st</sub>
44
+
1. PoPoolation2
45
+
1.{poolfstat}
46
+
1. grenedalf
47
+
1. Calculate Fisher's exact test for individual SNPs
48
+
1. PoPoolation2
49
+
1. assessPool native
50
+
1. Join frequency data to F<sub>st</sub> results
51
+
1. Extract contigs containing (user-configurable) strongly-differentiated loci
52
+
1. Create HTML report
53
+
1. Save all output data in tabular format for downstream analysis
30
54
31
55
<!-- TODO nf-core: Include a figure that guides the user through the major workflow steps. Many nf-core
32
56
workflows use the "tube map" design for that. See https://nf-co.re/docs/guidelines/graphic_design/workflow_diagrams#examples for examples. -->
33
-
<!-- TODO nf-core: Fill in short bullet-pointed list of the default steps in the pipeline -->
34
57
35
58
## Usage
36
59
37
60
> [!NOTE]
38
61
> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.
39
62
40
-
<!-- TODO nf-core: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
41
-
Explain what rows and columns represent. For instance (please edit as appropriate):
42
-
43
-
First, prepare a samplesheet with your input data that looks as follows:
63
+
First, prepare a sample sheet with your input data that looks as follows:
`pools` (optional): Comma-separated list of pool names (will replace any names in the input file)
79
+
`pool_sizes` (required): Number of individuals in each pool. Either a single number for uniform pool sizes or a comma-separated list of sizes for each pool.
55
80
56
-
Now, you can run the pipeline using:
57
81
58
-
<!-- TODO nf-core: update the following command to include all required parameters for a minimal example -->
82
+
Required columns are `project`, `input`, `reference`, and `pool_sizes`.
83
+
84
+
Now, you can run the pipeline using:
59
85
60
86
```bash
61
-
nextflow run nf-core/assesspool \
87
+
nextflow run tobodev/assesspool \
62
88
-profile <docker/singularity/.../institute> \
63
89
--input samplesheet.csv \
64
90
--outdir <OUTDIR>
@@ -67,41 +93,47 @@ nextflow run nf-core/assesspool \
67
93
> [!WARNING]
68
94
> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).
69
95
70
-
For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/assesspool/usage) and the [parameter documentation](https://nf-co.re/assesspool/parameters).
96
+
For more details and further functionality, please refer to the [usage documentation](docs/usage.md) and the [parameter documentation](parameters.md).
97
+
98
+
## Testing the pipeline
99
+
assessPool comes with two built-in profiles that allow the user to test the pipeline with a fully-functional input dataset. These profiles (whose descriptions can be found in [conf/test.confg](conf/test.config) and [conf/test_full.config](conf/test_full.config)) will run assessPool with either a full or reduced dataset of SNPs sequenced from wild populations of the coral *Montipora capitata*. Pipeline tests can be run by passing either `test` or `test_full` to the `-profile` option, along with a software/container management subsystem. For example, using singularity:
100
+
101
+
```
102
+
nextflow run tobodev/assesspool \
103
+
-profile test,singularity
104
+
```
105
+
or
106
+
```
107
+
nextflow run tobodev/assesspool \
108
+
-profile test_full,singularity
109
+
```
71
110
72
111
## Pipeline output
73
112
74
-
To see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/assesspool/results) tab on the nf-core website pipeline page.
113
+
Results of an example test run with a full size dataset can be found [here](https://tobodev.github.io/assesspool/).
75
114
For more details about the output files and reports, please refer to the
nf-core/assesspool was originally written by Evan B Freel, Emily E Conklin, Mykle L Hoban, Derek W Kraft, Jonathan L Whitney, Ingrid SS Knapp, Zac H Forsman, Robert J Toonen.
119
+
assessPool was originally written by Evan B Freel, Emily E Conklin, Mykle L Hoban, Derek W Kraft, Jonathan L Whitney, Ingrid SS Knapp, Zac H Forsman, Robert J Toonen.
81
120
82
121
We thank the following people for their extensive assistance in the development of this pipeline:
83
122
84
-
<!-- TODO nf-core: If applicable, make list of people who have also contributed -->
123
+
Richard Coleman, ʻAleʻalani Dudoit, and Cataixa López, who used assessPool during development and helped identify issues and suggest key feature improvements. We would also like to thank Iliana Baums, Tanya Beirne, Dave Carlon, Greg Conception, Matt Craig, Jeff Eble, Scott Godwin, Matt Iacchei, Frederique Kandel, Steve Karl, Jim Maragos, Bob Moffitt, Joe O'Malley, Lawrie Provost, Jennifer Salerno, Derek Skillings, Michael Stat, Ben Wainwright, and Kim Weersing, for their efforts in sample collection.
85
124
86
125
## Contributions and Support
87
126
88
127
If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).
89
128
90
-
For further information or help, don't hesitate to get in touch on the [Slack `#assesspool` channel](https://nfcore.slack.com/channels/assesspool) (you can join with [this invite](https://nf-co.re/join/slack)).
91
-
92
129
## Citations
93
130
94
-
<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->
95
-
<!-- If you use nf-core/assesspool for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->
96
-
97
-
<!-- TODO nf-core: Add bibliography of tools and data used in your pipeline -->
98
-
99
-
An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.
131
+
A list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.
100
132
101
-
You can cite the `nf-core` publication as follows:
133
+
This pipeline uses code and infrastructure developed and maintained by the [nf-core](https://nf-co.re) community, reused here under the [MIT license](https://github.com/nf-core/tools/blob/master/LICENSE).
102
134
103
-
> **The nf-core framework for community-curated bioinformatics pipelines.**
135
+
> The nf-core framework for community-curated bioinformatics pipelines.
104
136
>
105
137
> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.
106
138
>
107
-
> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).
139
+
> Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.
0 commit comments