Giter VIP home page Giter VIP logo

utility-pod's Introduction

Nextflow Tracer Use-Case Examples

Open in Gitpod

This repository provides an example of using Nextflow with our tracking & observability tool - Tracer.

To install Tracer on your initialized Gitpod workspace:

--> Create your account on Tracer --> Copy & Paste one-line installation script at https://app.tracer.bio/app/setup

Example 1: Nextflow RNASEQ training example with indexing & quantification

  1. INDEX and QUANTIFICATION processes are run and tracked by Tracer
  2. "nextflow run ./examples/example1.nf"

Example 2: Nextflow RNASEQ training example with indexing & quantification - Bacterial GEO dataset

  1. INDEX and QUANTIFICATION processes are run and tracked by Tracer using GEO E.coli dataset
  2. Details of dataset available at "./examples/data/bacteria/datasets.txt"
  3. "nextflow run ./examples/example2.nf"

Example 3: Nextflow RNASEQ training example with indexing & quantification - Human GEO dataset

  1. INDEX and QUANTIFICATION processes are run and tracked by Tracer using GEO human AML dataset
  2. Details of dataset available at "./examples/data/human/datasets.txt"
  3. "nextflow run ./examples/example3.nf"

Example 4: Shell script tracking for STAR mapper with RNASEQ data

  1. Generate a genome index and performs mapping of sample dataset using STAR

  2. Details of dataset available at "./examples/data/human/datasets.txt"

  3. "sh ./rnaseq/STAR.sh"

    Files

    • example1.nf, example2.nf, example3.nf : The main workflow script files.
    • index.nf: Contains the INDEX process definition [./examples/misc/]
    • quantpe.nf: Contains the QUANTIFICATION process definition. [./examples/misc/]

    Workspace

    • Conda and salmon are pre-configured in the workspace using docker.
    • Nextflow is pre-configured in the workspace using docker.
    • JAVA is pre-configured in the workspace using docker.
    • STAR is pre-configured in the workspace using docker.
    • Tracer: The tracking tool used in this workflow. Setup your Tracer account and record your unique API key at https://app.tracer.bio. Enter this one-line installation script prior to running other example scripts.

    Usage

    1. To clone the repository:

    git clone https://github.com/tracer-pod/utility-pod.git

    cd utility-pod

    Tracer Integration

    Tracer is integrated into the workflow to track the execution and versions of the processes. The workflow initiates Tracer at the beginning and terminates it at the end.

    License

    This project is licensed under the MIT License - see the LICENSE file for details.

    Acknowledgments

    • Thanks to the Nextflow community for their excellent documentation and support.

    GitPod

    Open in Gitpod


This README provides a comprehensive guide for users to understand and execute a nextflow RNA-Seq workflow with Tracer enabled tracking. Adjust the repository URL, license details, and acknowledgments as per your specific project details.

utility-pod's People

Contributors

tw599 avatar tracerbio 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.