Skip to content

Deeploid-Meta/deeploid-mini-cli

Repository files navigation

Deeploid mini

Command Line Interface

1 2 3 4



📌Features

Начиная процесс анализа метагеномных данных мы столкнулись с тем, что проблемы есть не только с данными, но и с инструментами. Существующие решения не только громоздкие, но и позволяют сделать ошибки неопытным пользователям. А эти ошибки приводят к неправильной интерпретации результатов, что недопустимо, когда это касается, например, здоровья человека.

Все фишки и преимущества нашего приложения можно посмотреть на нашем сайте DeepLoid

📌Installation

Install, set and run (Linux/MacOS)

Note that full installation is not possible from Windows, because some of the dependencies are Unix (Linux/MacOS) only. For Windows, please use the minimal installation below.

Snakemake can be installed with all goodies needed to run in any environment and for creating interactive reports via

conda install -n base -c conda-forge mamba
conda activate base
mamba create -c conda-forge -c bioconda -n snakemake snakemake

from the Bioconda channel. This will install snakemake into an isolated software environment, that has to be activated with

conda activate snakemake
snakemake --help

Installing into isolated environments is best practice in order to avoid side effects with other packages.

Minimal installation (Windows)

A minimal version of Snakemake which only depends on the bare necessities can be installed with

conda install -n base -c conda-forge mamba
conda activate base
mamba create -c bioconda -c conda-forge -n snakemake snakemake-minimal

In contrast to the full installation, which depends on some Unix (Linux/MacOS) only packages, this also works on Windows.

📌 Quick Start

тут пока храняться данные для тестовых прогонов:

  pip install poetry
  poetry install
  dvc pull 

After snakemake env activate:

При запуске любого скрипта создается папка path/output и в ней появляются ASV.csv, taxonomy.tsv и папка pipeline_artifacts

  • deblur_pipeline.py

    python3 deeploid_cli.py -t deblur -1 data/standart_dataset/mock_2_R1.fastq -2 data/standart_dataset/mock_2_R2.fastq -db databases/GG/85_otus_classifier.qza -tx databases/GG/85_otu_taxonomy.txt -o path/output
    
  • qiime2_pipeline.py

    python3 deeploid_cli.py -t qiime2 -1 data/standart_dataset/mock_2_R1.fastq -2 data/standart_dataset/mock_2_R2.fastq -db databases/GG/85_otus.fasta -tx databases/GG/85_otu_taxonomy.txt -o path/output
    
  • dada2_pipeline.R

    python3 deeploid_cli.py -t dada2 -1 mock_2_R1.fastq -2 mock_2_R2.fastq -db databases/dada/silva_nr99_v138.1_train_set.fa.gz -o path/output
    
  • vsearch_pipeline.py

    python3 deeploid_cli.py -t vsearch -1 data/standart_dataset/mock_2_R1.fastq -2 data/standart_dataset/mock_2_R2.fastq -db databases/GG/85_otus_classifier.qza -o path/output
    

📌Community

Your team!

Цитирование

Если вы используете CLI в своих исследованиях, рассмотрите возможность цитирования

@misc{=Command Line Interface,
    title={High Performance CLI},
    author={Deeploid Contributors},
    howpublished = {\url{https://github.com/Deeploid-Meta/deeploid-mini-cli}},
    year={2023}
}

Благодарность

Лицензия

The MIT License