From e361d5513bb2f3a39e54ddc757828b82a085fcbc Mon Sep 17 00:00:00 2001 From: nf-core-bot Date: Mon, 18 Mar 2024 15:51:18 +0000 Subject: [PATCH] [automated] Fix code linting --- README.md | 19 ++++++++++--------- assets/schema_input_panel.json | 4 ++-- docs/development.md | 6 +++--- docs/usage.md | 9 ++++++++- nextflow_schema.json | 2 +- tests/config/env_nf.yml | 2 +- 6 files changed, 25 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 6dd32db5..bc0384fb 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,10 @@ The **phaseimpute** pipeline is constituted of 5 main steps: -| Metro map | Modes | -|-----------|-------------| +| Metro map | Modes | +| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | metromap | - **Pre-processing**: Phasing, QC, variant filtering, variant annotation of the reference panel
- **Phase**: Phasing of the target dataset on the reference panel
- **Simulate**: Simulation of the target dataset from high quality target data
- **Concordance**: Concordance between the target dataset and a truth dataset
- **Post-processing**: Variant filtering based on their imputation quality | + ## Usage > [!NOTE] @@ -69,13 +70,13 @@ For more details and further functionality, please refer to the [usage documenta Here is a short description of the different mode of the pipeline. For more information please refer to the [documentation](https://nf-core.github.io/phaseimpute/usage/). -| Mode | Flow chart | Description | -|-------------------|-----------------------------------------------------------------|----------------------------------------------------------------------------------------| -| **Preprocessing** | phase_metro | The preprocessing mode is responsible to the preparation of the multiple input file that will be used by the phasing process.
The main processes are :
- **Haplotypes phasing** of the reference panel using [**Shapeit5**](https://odelaneau.github.io/shapeit5/).
- **Filter** the reference panel to select only the necessary variants.
- **Chunking the reference panel** in a subset of region for all the chromosomes.
- **Extract** the positions where to perform the imputation.| -| **Phasing** | phase_metro | The phasing mode is the core mode of this pipeline.
It is constituted of 3 main steps:
- **Phasing**: Phasing of the target dataset on the reference panel using either:
  - [**Glimpse1**](https://odelaneau.github.io/GLIMPSE/glimpse1/index.html)
  It's come with the necessety to compute the genotype likelihoods of the target dataset.
  This step is done using [BCFTOOLS_mpileup](https://samtools.github.io/bcftools/bcftools.html#mpileup)
  - [**Glimpse2**](https://odelaneau.github.io/GLIMPSE/glimpse2/index.html) For this step the reference panel is transformed to binary chunks.
  - [**Stitch**](https://github.com/rwdavies/stitch)
  - [**Quilt**](https://github.com/rwdavies/QUILT)
- **Ligation**: all the different chunks are merged together.
- **Sampling** (optional) | -| **Simulate** | simulate_metro | The simulation mode is used to create artificial low informative genetic information from high density data. This allow to compare the imputed result to a *truth* and therefore evaluate the quality of the imputation.
For the moment it is possible to simulate:
- Low-pass data by **downsample** BAM or CRAM using [SAMTOOLS_view -s]() at different depth
- Genotype data by **SNP selecting** the position used by a designated SNP chip.
The simulation mode will also compute the **Genotype likelihoods** of the high density data. | -| **Concordance** | concordance_metro | This mode compare two vcf together to compute a summary of the differences between them.
To do so it use either:
- [**Glimpse1**](https://odelaneau.github.io/GLIMPSE/glimpse1/index.html) concordance process.
- [**Glimpse2**](https://odelaneau.github.io/GLIMPSE/glimpse2/index.html) concordance process
- Or convert the two vcf fill to `.zarr` using [**Scikit allele**](https://scikit-allel.readthedocs.io/en/stable/) and [**anndata**](https://anndata.readthedocs.io/en/latest/) before comparing the SNPs. | -| **Postprocessing**| postprocessing_metro | This final process unable to loop the whole pipeline for increasing the performance of the imputation. To do so it filter out the best imputed position and rerun the analysis using this positions. | +| Mode | Flow chart | Description | +| ------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Preprocessing** | phase_metro | The preprocessing mode is responsible to the preparation of the multiple input file that will be used by the phasing process.
The main processes are :
- **Haplotypes phasing** of the reference panel using [**Shapeit5**](https://odelaneau.github.io/shapeit5/).
- **Filter** the reference panel to select only the necessary variants.
- **Chunking the reference panel** in a subset of region for all the chromosomes.
- **Extract** the positions where to perform the imputation. | +| **Phasing** | phase_metro | The phasing mode is the core mode of this pipeline.
It is constituted of 3 main steps:
- **Phasing**: Phasing of the target dataset on the reference panel using either:
  - [**Glimpse1**](https://odelaneau.github.io/GLIMPSE/glimpse1/index.html)
  It's come with the necessety to compute the genotype likelihoods of the target dataset.
  This step is done using [BCFTOOLS_mpileup](https://samtools.github.io/bcftools/bcftools.html#mpileup)
  - [**Glimpse2**](https://odelaneau.github.io/GLIMPSE/glimpse2/index.html) For this step the reference panel is transformed to binary chunks.
  - [**Stitch**](https://github.com/rwdavies/stitch)
  - [**Quilt**](https://github.com/rwdavies/QUILT)
- **Ligation**: all the different chunks are merged together.
- **Sampling** (optional) | +| **Simulate** | simulate_metro | The simulation mode is used to create artificial low informative genetic information from high density data. This allow to compare the imputed result to a _truth_ and therefore evaluate the quality of the imputation.
For the moment it is possible to simulate:
- Low-pass data by **downsample** BAM or CRAM using [SAMTOOLS_view -s]() at different depth
- Genotype data by **SNP selecting** the position used by a designated SNP chip.
The simulation mode will also compute the **Genotype likelihoods** of the high density data. | +| **Concordance** | concordance_metro | This mode compare two vcf together to compute a summary of the differences between them.
To do so it use either:
- [**Glimpse1**](https://odelaneau.github.io/GLIMPSE/glimpse1/index.html) concordance process.
- [**Glimpse2**](https://odelaneau.github.io/GLIMPSE/glimpse2/index.html) concordance process
- Or convert the two vcf fill to `.zarr` using [**Scikit allele**](https://scikit-allel.readthedocs.io/en/stable/) and [**anndata**](https://anndata.readthedocs.io/en/latest/) before comparing the SNPs. | +| **Postprocessing** | postprocessing_metro | This final process unable to loop the whole pipeline for increasing the performance of the imputation. To do so it filter out the best imputed position and rerun the analysis using this positions. | ## Pipeline output diff --git a/assets/schema_input_panel.json b/assets/schema_input_panel.json index 8ea65acf..49593176 100644 --- a/assets/schema_input_panel.json +++ b/assets/schema_input_panel.json @@ -18,7 +18,7 @@ "pattern": "^\\S+\\.vcf$", "errorMessage": "Panel vcf file must be provided, cannot contain spaces and must have extension '.vcf'" }, - "index":{ + "index": { "type": "string", "pattern": "^\\S+\\.vcf\\.(tbi|csi)$", "errorMessage": "Panel vcf index file must be provided, cannot contain spaces and must have extension '.vcf.tbi' or '.vcf.csi'" @@ -33,7 +33,7 @@ "pattern": "^\\S+\\.tsv$", "errorMessage": "Panel tsv file must be provided, cannot contain spaces and must have extension '.tsv'" }, - "legend":{ + "legend": { "type": "string", "pattern": "^\\S+\\.legend$", "errorMessage": "Panel legend file must be provided, cannot contain spaces and must have extension '.legend'" diff --git a/docs/development.md b/docs/development.md index da2f2098..2dcc411d 100644 --- a/docs/development.md +++ b/docs/development.md @@ -37,13 +37,13 @@ All channel need to be identified by a meta map as follow: - T : tool used - G : reference genome used (is it needed ?) - ## Open questions How to use different schema ? + - Use nf-validation -For the moment use different input / step. -In the futur, if/else logic will be added in the yml nf-core schema. + For the moment use different input / step. + In the futur, if/else logic will be added in the yml nf-core schema. What's the use of dumpcustomsoftware ? Will be deleted diff --git a/docs/usage.md b/docs/usage.md index 20f92f3d..ec9617d8 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -3,6 +3,7 @@ ## :warning: Please read this documentation on the nf-core website: [https://nf-co.re/phaseimpute/usage](https://nf-co.re/phaseimpute/usage) > _Documentation of pipeline parameters is generated automatically from the pipeline schema and can no longer be found in markdown files._ + ## :warning: Please read this documentation on the nf-core website: [https://nf-co.re/phaseimpute/usage](https://nf-co.re/phaseimpute/usage) > _Documentation of pipeline parameters is generated automatically from the pipeline schema and can no longer be found in markdown files._ @@ -12,6 +13,7 @@ ## Samplesheet input + ## Samplesheet input @@ -171,8 +173,9 @@ If `-profile` is not specified, the pipeline will run locally and expect all sof - `apptainer` - A generic configuration profile to be used with [Apptainer](https://apptainer.org/) - `conda` + - A generic configuration profile to be used with [Conda](https://conda.io/docs/). Please only use Conda as a last resort i.e. when it's not possible to run the pipeline with Docker, Singularity, Podman, Shifter, Charliecloud, or Apptainer. -If `-profile` is not specified, the pipeline will run locally and expect all software to be installed and available on the `PATH`. This is _not_ recommended, since it can lead to different results on different machines dependent on the computer enviroment. + If `-profile` is not specified, the pipeline will run locally and expect all software to be installed and available on the `PATH`. This is _not_ recommended, since it can lead to different results on different machines dependent on the computer enviroment. - `test` - A profile with a complete configuration for automated testing @@ -307,5 +310,9 @@ We recommend adding the following line to your environment to limit this (typica ```bash NXF_OPTS='-Xms1g -Xmx4g' ``` + NXF_OPTS='-Xms1g -Xmx4g' + +``` + ``` diff --git a/nextflow_schema.json b/nextflow_schema.json index 2a19f601..7124fefd 100644 --- a/nextflow_schema.json +++ b/nextflow_schema.json @@ -48,7 +48,7 @@ } ] }, - "panel_index":{ + "panel_index": { "type": "string", "description": "Path to the reference panel index file", "fa_icon": "far fa-file-code", diff --git a/tests/config/env_nf.yml b/tests/config/env_nf.yml index 45f78e2f..e3b11408 100644 --- a/tests/config/env_nf.yml +++ b/tests/config/env_nf.yml @@ -10,4 +10,4 @@ dependencies: - singularity>=3.8 - nf-core>=2.13.0 - prettier>=3.0 - - nf-test>=0.8 \ No newline at end of file + - nf-test>=0.8