cldla

workflow to identify QTLs using mixed linear models and variance component estimation

https://github.com/popgen48/cldla

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

workflow to identify QTLs using mixed linear models and variance component estimation

Basic Info
  • Host: GitHub
  • Owner: Popgen48
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Homepage:
  • Size: 11.7 MB
Statistics
  • Stars: 2
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

Introduction

popgen-cldla is a fully automated workflow to identify QTLs using combined linkage disequilibrium and linkage analysis (CLDLA). Unlike genome-wide association study (GWAS), cLDLA is a mixed-linear-model (MLM) based apporach to estimate variance component of each putative QTL using the specialized tools such as ASREML and blupf90+.

The workflow consists of the following steps:

  1. Phase the genotypes using beagle or shapeit (optional)
  2. Filtering the SNPs (optional)
  3. Estimation of genetic relationship across genome (GRM)
  4. Estimation of genetic relationship at each putative QTL region (DRM)
  5. Bending and inverting GRM and DRM
  6. Variance component estimation
  7. Plotting the results in the form of manhattan plot

Note that the workflow currently only supports the singularity container

Input files

  1. List of phased or unphased vcf files in a csv format

Bash 10,/data/testing/TailMLS04/OUT_VCF_BEAGLE4_ALL_OARAutoSom1_Chr10.TxT.vcf.gz,/data/testing/TailMLS04/OUT_VCF_BEAGLE4_ALL_OARAutoSom1_Chr10.TxT.vcf.gz.csi 11,/data/testing/TailMLS04/OUT_VCF_BEAGLE4_ALL_OARAutoSom1_Chr11.TxT.vcf.gz,/data/testing/TailMLS04/OUT_VCF_BEAGLE4_ALL_OARAutoSom1_Chr11.TxT.vcf.gz.csi . . .

  1. Phenotype file

Bash iidx iid sex age bodywgt witherhgt taillgt 1 MLS169 1 11 10.6 47.0 32.7 2 MLS170 1 9 12.0 44.2 33.6 . . .

Note that the header should be present in the phenotype file and first, second and the last column in the phenotype file should be the index of individuals (with the header: iidx), individual id (with the header: iid) and the trait (Y), respectively.

  1. Parameter file

Depending on the tool specified by the user, the workflow will generate the parameter file. things to consider in the parameter template file

  1. If you have not used any of the two programs (asreml and blupf90+) implemented for variance component estimation before, please Refer to its respective documentation: asreml documentation or blupf90+ documentation. | 2. Note that in the current version, the MLMs are tested with two mixed effects : additive polygenic effect and additive QTL effects.

Example commands to run the workflow

To identify QTLs using CLDLA approach

Bash nextflow run cldla/ --input chrom_vcf_idx.csv --maf 0.05 --pheno_file TailMLS04.template.phe -qs 10 --outdir testing_blupf90_TailMLS04 -resume -profile singularity --output_prefix TailMLS04 --tool blupf90

To estimate heritability using the approach as implemented in GCTA

Bash nextflow run cldla/ --input nextflow_testing/TailMLS04/chrom_vcf_idx.csv --maf 0.05 --pheno_file nextflow_testing/TailMLS04/TailMLS04.template.phe -qs 10 --outdir testing_h2_TailMLS04 -resume -profile singularity --output_prefix TailMLS04_h2 --estimate_h2

Note that estimation of heritability using GCTA requires that the regressors be separated into two files: quantitative variables and qualitative variables. Therefore, in the phenotype file, any column with the float values (identified using the presence of dot,\".\") are automatically classified as quantitative and the column without float values are classified as qualitative. Further, the workflow to estimate h2, will produce the error if there is any column with mixtures of float and integer values.

Description of the parameters

Bash --input [string] Path to comma-separated file containing information about the samples in the experiment. --outdir [string] The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure. --email [string] Email address for completion summary. --maf [number] minor allele frequency threshold; SNPs with MAF less than this threshold will filtered out --window_size [number] Window size to carry out cLDLA analysis [default: 40] --output_prefix [string] output prefix should not contain the dot in it [default: cldla_run1] --pheno_file [string] path to the phenotypes file as recognized by echidna --p_value [number] p-value cutoff based on permutation test --include_chrom [string] file containing ids of chromosome on which cLDLA will be carried out --num_autosomes [number] total number of autosomes in the dataset --estimate_h2 [boolean] whether to estimate heritability using gcta tool --lrt_threhold [number] lrt values above which the values are significant [default: 18] --tool [string] tool to estimate variance components [default: blupf90] --par_file [string] parameter file of the tool --n_perm [integer] number of permutation test to be carried out to determine the significant threshold for CLDLA or H2 estimation [default: 100] --phase_genotypes [boolean] whether or not to phase the genotypes --phasing_panel [string] csv file containing information about path to the vcf files to be used for imputation --phasing_map [string] csv file containing information about path to the recombination map files --phasing_tool [string] tool to be used for phasing: beagle5 or shapeit5 [default: beagle5]

Owner

  • Name: Popgen48
  • Login: Popgen48
  • Kind: organization

Citation (CITATIONS.md)

# nf-core/cldla: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
  > Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
  • Watch event: 3
  • Push event: 25
Last Year
  • Watch event: 3
  • Push event: 25

Issues and Pull Requests

Last synced: about 2 years ago

All Time
  • Total issues: 0
  • Total pull requests: 57
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 57
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • BioInf2305 (12)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/awsfulltest.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v1 composite
.github/workflows/awstest.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v1 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/clean-up.yml actions
  • actions/stale v7 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • mshick/add-pr-comment v1 composite
  • nf-core/setup-nextflow v1 composite
  • psf/black stable composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact v2 composite
  • marocchino/sticky-pull-request-comment v2 composite
modules/nf-core/bcftools/concat/meta.yml cpan
modules/nf-core/bcftools/view/meta.yml cpan
modules/nf-core/beagle5/beagle/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
modules/nf-core/plink2/vcf/meta.yml cpan
Dockerfile docker
  • rocker/r-ubuntu jammy build
pyproject.toml pypi
requirements.txt pypi
  • bokeh ==3.3.1
  • numpy ==1.26.1
  • pysam ==0.22.0
  • scipy ==1.11.3
modules/nf-core/shapeit5/phasecommon/meta.yml cpan
modules/nf-core/tabix/tabix/meta.yml cpan
environment.yml conda
  • bokeh
  • gfortran 13.2.0.*
  • pysam 0.20.0.*
  • python 3.10.*
modules/local/python3/manhattan_plot/environment.yml conda
  • bokeh 3.2.1
  • pandas 2.1.4
  • python 3.10.13
  • pyyaml 6.0.1
modules/local/python3/prepare_manhttan_plot_input/environment.yml conda
  • numpy 1.26.3
  • pandas 2.1.4
  • python 3.10.13
modules/nf-core/bcftools/concat/environment.yml conda
  • bcftools 1.20.*
modules/nf-core/plink2/vcf/environment.yml conda
  • plink2 2.00a2.3.*
modules/local/python3/filter_vcf/environment.yml pypi
modules/local/python3/vcftolgen/environment.yml pypi
modules/nf-core/bcftools/view/environment.yml pypi
modules/nf-core/beagle5/beagle/environment.yml pypi
modules/nf-core/custom/dumpsoftwareversions/environment.yml pypi
modules/nf-core/multiqc/environment.yml pypi
modules/nf-core/shapeit5/phasecommon/environment.yml pypi
modules/nf-core/tabix/tabix/environment.yml pypi