staphylores

Trabajo de Fin de Máster, Máster Universitario en Bioinformática, Universidad Europea de Madrid.

https://github.com/victorpizarror/staphylores

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
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (4.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Trabajo de Fin de Máster, Máster Universitario en Bioinformática, Universidad Europea de Madrid.

Basic Info
  • Host: GitHub
  • Owner: VictorPizarroR
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Size: 2.43 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

StaPhyloRes Logo

Nextflow Run with Conda Run with Docker GitHub release License: MIT

Introducción

Read in English.

StaPhyloRes es un pipeline bioinformatico el cual permite realizar análisis de calidad de secuencias, ensamblaje, detección de genes de resistencia a antibióticos, virulencia, tipificación molecular, análisis filogenético y predicción fenotípica de sensibilidad antibiótica en cepas de Staphylococcus aureus.

El pipeline está construido usando Nextflow, una herramienta para ejecutar tareas en múltiples infraestructuras computacionales de manera muy portátil.

Este trabajo forma parte del Trabajo de Fin de Máster del Máster Universitario en Bioinformática de la Universidad Europea de Madrid.

Herramientas Usadas

| Proceso | Herramienta | |-------------------------------|--------------------------------------------------------------------------------------------------------| | Control de calidad de lecturas | FastQC | | Trimado de lecturas | FastP | | Ensamblaje de genomas | Unicycler | | Control de calidad de ensamblados | Quast | | Anotación de genes | Prokka | | Predicción de resistencia fenotípica | Mykrobe | | Análisis de resistencia | ARIBA, ABRICATE, STARARM | | Filogenia | MASH, NCBI-genome-download, Snippy, IQTree, Gubbins, MASH-Tree | | Tipado Molecular | MLST, Spatyper, Staphopia SCCmec, AgrVATE. | Informes de calidad | MultiQC

Workflow

staphylores_pipeline_graph

Modo de Uso

Nota: Si eres nuevo en Nextflow y nf-core, consulta esta página para configurar Nextflow. Asegúrate de probar tu configuración con -profile test antes de ejecutar el pipeline con datos reales.

Preparación de los Datos

Prepara una samplesheet con las secuencias R1 y R2. El formato de la samplesheet.csv debe ser el siguiente:

csv sample,fastq_1,fastq_2 IDENTIFICADOR,XXXXXXX_XX_L002_R1_001.fastq.gz,XXXXXXX_XX_L002_R2_001.fastq.gz

Puedes utilizar el script Crear SCV incluido en la carpeta: resources para crear esta samplesheet:

bash ./Crear_CSV.bash inputdir/

Cada fila representa un par de archivos fastq (paired end).

Preparación del Entorno

Crear un entorno de Conda a partir del archivo YML proporcionado:

bash conda env create -f StaPhyloRes/resourses/resvirpredictor.yml --name env_name

Activa el entorno:

bash conda activate env_name


Ejecución Básica

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/

Este comando ejecutará el análisis, que incluye:

  • Análisis de calidad de secuencias raw
  • Trimado y análisis de calidad de secuencias trimadas
  • Ensamblaje
  • Análisis de calidad de ensamblados
  • Predicción de resistencia fenotípica basada en el análisis genómico
  • Búsqueda de genes de resistencia y virulencia en secuencias cortas y ensamblados
  • Estudio MLST para Staphylococcus aureus
  • Generación de informes consolidados

Profiles disponibles:

CONDA

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/ -profile conda

DOCKER

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/ -profile docker


Análisis Opcionales y Complementarios

Uso de una Base de Datos Personalizada

El pipeline puede usar una base de datos personalizada, "staph_vf.fasta", en el directorio resources. Para usarla:

  1. Verifica la base de datos de Abricate:

bash abricate --datadir

  1. Copia el archivo staph_vf.fasta:

```bash cp StaPhyloRes/resources/staph_vf.fasta /pathtobd/staph/sequences

abricate --setupdb ```

  1. Ejecuta el pipeline:

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/ --abricate_db true


Estudio de Filogenia

Descarga la base de datos de referencia MASH:

bash https://gembox.cbcb.umd.edu/mash/refseq.genomes.k21s1000.msh

Ejecuta el pipeline con la referencia de MASH:

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/ --phylogeny true --mash_reference pathtomashreference.msh


Comandos

Input/Output Options

  • --input [string]: Ruta al archivo CSV de muestras.
  • --outdir [string]: Directorio de salida para los resultados.
  • --abricate_db [boolean]: Utiliza una base de datos personalizada.
  • --gubbins [boolean]: Alternativa a Snippy para el análisis filogenético.
  • --email [string]: Dirección de correo electrónico para recibir un resumen de la finalización del pipeline.

Skip Options

  • --skip_unicycler [boolean]: Omite la ejecución de Unicycler.
  • --skip_ariba [boolean]: Omite el análisis con ARIBA.
  • --skip_assemblyanalisis [boolean]: Omite el análisis con Abricate y Staramr.
  • --skip_mykrobe [boolean]: Omite el análisis con Mykrobe.
  • --skip_mlst [boolean]: Omite el estudio MLST.

Opciones para Estudio de Filogenia

  • --phylogeny [boolean]:Activa el análisis filogenético. (Genoma de referencia obtenido de aquí).
  • --mash_reference [string]: Ruta a la referencia MASH.

Opciones de Solicitud Máxima de Trabajos

  • --max_cpus [integer]: Número máximo de CPUs que se pueden solicitar para cualquier trabajo individual. [default: 16]
  • --max_memory [string]: Cantidad máxima de memoria que se puede solicitar para cualquier trabajo individual. [default: 12.GB]
  • --max_time [string]: Tiempo máximo que se puede solicitar para cualquier trabajo individual. [default: 240.h]

Opciones Genéricas

  • --help [boolean]: Muestra el texto de ayuda.

Cambiar el Directorio de Trabajo en la Línea de Comandos

Puedes especificar un directorio de trabajo personalizado al ejecutar el pipeline usando la opción -work-dir.

bash nextflow run StaPhyloRes/ --input samplesheet.csv --outdir outdirpath/ -work-dir /path/to/custom/workdir

Resultados

Para ver los resultados de una ejecución de prueba con un conjunto de datos de tamaño completo, consulta la carpeta results contenida en esta pagina.

Créditos

StaPhyloRes fue desarrollado por Víctor Pizarro Riveros como parte de su Trabajo de Fin de Máster en Bioinformática de la Universidad Europea de Madrid.

Agradecimientos especiales a la comunidad nf-core por proporcionar herramientas bajo la licencia MIT.

Citación

Una lista completa de referencias para las herramientas utilizadas por el pipeline se puede encontrar en el archivo CITATIONS.md.

This pipeline uses code and infrastructure developed and maintained by the nf-core initative, and reused here under the MIT license.

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

Owner

  • Login: VictorPizarroR
  • Kind: user

Citation (CITATIONS.md)

# nf-core/resvirpredictor: 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/)

  > Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].

- [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)

  > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. 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
  • Release event: 1
  • Push event: 14
  • Create event: 1
Last Year
  • Release event: 1
  • Push event: 14
  • Create event: 1

Dependencies

.github/workflows/awsfulltest.yml actions
  • actions/upload-artifact v4 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/awstest.yml actions
  • actions/upload-artifact v4 composite
  • seqeralabs/action-tower-launch v2 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
.github/workflows/ci.yml actions
  • actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
  • jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/clean-up.yml actions
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
.github/workflows/download_pipeline.yml actions
  • actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
  • eWaterCycle/setup-singularity 931d4e31109e875b13309ae1d07c70ca8fbc8537 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
  • actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
  • peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
.github/workflows/linting.yml actions
  • actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
  • actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact f6b0bace624032e30a85a8fd9c1a7f8f611f5737 composite
  • marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
.github/workflows/release-announcements.yml actions
  • actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
  • rzr/fediverse-action master composite
  • zentered/bluesky-post-action 80dbe0a7697de18c15ad22f4619919ceb5ccf597 composite
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
subworkflows/nf-core/utils_nextflow_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfcore_pipeline/meta.yml cpan
subworkflows/nf-core/utils_nfvalidation_plugin/meta.yml cpan
modules/nf-core/fastqc/environment.yml pypi
modules/nf-core/multiqc/environment.yml pypi
pyproject.toml pypi