Giter VIP home page Giter VIP logo

nf-feelnc's Introduction

nf-feelnc: A simple nf pipeline fir running feelnc tools

nf-feelnc is a Nexflow pipeline for detection of lncRNA in reference and non reference genome annotation using feelnc program. It takes care of uncompressing genome and run the 3 feelnc scripts. This simple pipeline has been extracted and modified from TAGADA pipeline.

Table of Contents

Dependencies

To use this pipeline you will need:

Usage

A small dataset is provided to test this pipeline. To try it out, use this command:

nextflow run sguizard/nf-feelnc -profile test,docker -revision 1.2

Nextflow Options

The pipeline is written in Nextflow, which provides the following default options:

Option Parameters Description Requirement
-profile profile1,profile2 Profile(s) to use when
running the pipeline.
Specify the profiles that
fit your infrastructure
among singularity,
docker, kubernetes,
slurm.
Required
-revision version Version of the pipeline
to launch.
Optional
-work-dir directory Work directory where
all temporary files are
written.
Optional
-resume Resume the pipeline
from the last completed
process.
Optional

For more Nextflow options, see Nextflow's documentation.

Pipeline Options

Option Parameters Description Requirement
--ref_annotation ref_annotation.gtf Input reference
annotation file or url.
Required
--new_annotation new_annotation.gtf Input reference
annotation file or url.
Required
--genome genome.fa Input genome
sequence file or url.
Required
--feelnc-args '--mode shuffle' Custom arguments to
pass to FEELnc's
coding potential script
when detecting long
non-coding transcripts.
Optional
--max-cpus 16 Maximum number of
CPU cores that can be
used for each process.
This is a limit, not the
actual number of
requested CPU cores.
Optional
--max-memory 64GB Maximum memory that
can be used for each
process. This is a limit,
not the actual amount
of alloted memory.
Optional
--max-time 12h Maximum time that can
be spent on each
process. This is a limit
and has no effect on the
duration of each process.
Optional

Workflow and Results

The pipeline executes the following processes:

  1. Decompress annotations and/or genome files if its gziped.
  2. Detect long non-coding transcripts with FEELnc.
    The annotation saved to results/annotation is updated with the results.
  3. Aggregate quality controls into a report with MultiQC.
    The report is saved to results/control in a .html file.

Aknowledgements

Many thanks to Sarah Djebali (@sdjebali), Sylvain Foissac, Cervin Guyomar and Cyril Kurylo for their help and advices.

About

The GENE-SWitCH project has received funding from the European Union’s Horizon 2020 research and innovation program under Grant Agreement No 817998.

This repository reflects only the listed contributors views. Neither the European Commission nor its Agency REA are responsible for any use that may be made of the information it contains.

nf-feelnc's People

Contributors

sguizard avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.