hisat2-pipeline

A pipeline to automatically perform an RNA-seq analysis using HISAT2 and stringtie

https://github.com/mcamagna/hisat2-pipeline

Science Score: 54.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
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

A pipeline to automatically perform an RNA-seq analysis using HISAT2 and stringtie

Basic Info
  • Host: GitHub
  • Owner: mcamagna
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 72.3 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 17
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

HISAT2-pipeline DOI

This pipeline runs a RNA-seq analysis automatically, using HISAT2/Stringtie with default settings. The pipeline should be particularly useful for people who lack the necessary skills to script their own pipeline or people who run RNA-seqs frequently. Please note, that it will not trim your reads, as modern mappers such as HISAT2 can handle untrimmed reads very well in almost all cases. If you wish to trim your reads anyways, please do so before running this pipeline.

1. Installation:

The preferred way to install the pipeline is via (bio)conda, as this will also install all required dependencies. Simply run the following command to install the pipeline:

conda install -c bioconda hisat2-pipeline If you encounter issues during the installation, try running these commands before trying the command above again:

conda config --add channels defaults conda config --add channels bioconda conda config --add channels conda-forge

2. Running an RNA-seq analysis

If not otherwise specified, the pipeline will expect the following file structure: your_folder └── genome └── reads The reads folder should contain your read data (.fastq |.fq |.fastq.gz|.fq.gz)
The genome will have to contain the genome fasta file (can be gzipped), as well as the corresponding gff file.

Then simply run the following command to run the analysis: hisat2-pipeline

The pipeline will ask you for feedback before proceeding to the actual analysis, to confirm whether it was able to infer all settings correctly.
Upon completion, you will find a folder called ./mapping containing the mapped *.bam files, as well as a a mapping_summary containing the merged mapping summary for all files as tab-separated and Excel file.

Gene expression values are found in the folder ./abundance, as well as the mergedFPKM and mergedTPM files (both as tab-separated and Excel files)

3. Advanced parameters

You can manually specify the reads, genome and output folders via: hisat2-pipeline --reads_folder [YOUR_READS_FOLDER] --genome_folder [YOUR_GENOME_FOLDER] --outfolder [YOUR_OUTPUT_FOLDER] This pipeline uses the default parameters for HISAT2 and Stringtie, but additional options can be specified. The example below shows how: hisat2-pipeline --hisat_options "--very-sensitive --no-spliced-alignment" --stringtie_options "-m 150 -t" To see all run parameters, use: hisat2-pipeline -h

4. Citing

If you use this software for your scientific research, please cite it. Refer to the about section for informations on how to cite this software or see the CITATION.cff file.

Owner

  • Name: Maurizio Camagna
  • Login: mcamagna
  • Kind: user
  • Company: Graduate School of Bioagricultural Sciences Nagoya University

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Camagna
    given-names: Maurizio
    orcid:  https://orcid.org/0000-0001-6340-8079
title: "HISAT2-pipeline"
version: 1.0.0
date-released: 2022-03-29
doi: 10.5281/zenodo.6416258
url: "https://github.com/mcamagna/HISAT2-pipeline"

GitHub Events

Total
  • Release event: 5
  • Delete event: 1
  • Push event: 5
  • Create event: 5
Last Year
  • Release event: 5
  • Delete event: 1
  • Push event: 5
  • Create event: 5