Git Product home page Git Product logo

ledakatopodi / library-of-cheatsheets Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 763 KB

๐Ÿ“‘ A library of example code -aka cheatsheets- for tools I use or analyses I carry out pretty often. This repo doubles as an easy way to find the code I need without going through all my scripts.

License: MIT License

Shell 100.00%
bioinformatics cheatsheets rna-seq tcr-repertoire visualization whole-exome-sequencing

library-of-cheatsheets's Introduction

library-of-cheatsheets

A library of example code -aka cheatsheets- for tools I use or analyses I carry out pretty often. This repo doubles as an easy way to find the code I need without going through all my scripts.

Library

๐Ÿ“š Cheatsheets

In the frame of this repository, a Cheatsheet is a collection of commands that runs a specific tool or pipeline from start to end, ensuring an expected behavior. For example, a cheatsheet can include the necessary code for the implementation of an analysis or the generation of a plot. A single cheatsheet usually pertains a specific tool (see Tools subfolder), but can be extended to a collection of tools or a pipeline (see Pipelines subfolder).

Each cheatsheet follows the naming conventions below, to ensure better organization of this repo:

  • Cheatsheet main script: {name of tool or pipeline}.run.{sh/Rmd/R/ipynb/py}. This is the main script needed to run the tool or pipeline of interest. All other auxiliary files and scripts are called by the cheatsheet main script. It usually comes in the form of a wrapper script or bash script, an RMarkdown or Rscript, or a Jupyter notebook or Python script, depending on the tools utilized.
  • Auxiliary scripts: {name of tool or pipeline}.aux_src.{purpose id of this file}.{sh/Rmd/R/ipynb/py}. These are scripts that perform specific tasks and are called by the main script. Auxiliary scripts are used in junction with the main script to avoid code clutter in the main script. The auxiliary scripts are standalone entities that can be run on their own if needed.
  • Auxiliary files: {name of tool or pipeline}.aux.{id for contents of file}.{txt/tsv/csv/bed...}.

In effect, one only needs to run the cheatsheet's main script to get the expected output, but the individual auxiliary scripts can be run indipendently if needed.

โš ๏ธ Disclaimer: The code for each cheatsheet is optimized in terms of arguments, path architecture, and naming conventions to facilitate my reusing of this code. To facilitate the use of the code by other users, I try to document the adjustments needed as well as provide the appropriate references.

๐Ÿ›๏ธ Repository Architecture

โ”œโ”€โ”€ Pipelines
โ”‚ย ย  โ””โ”€โ”€ GATK_WES
โ”‚ย ย      โ””โ”€โ”€ src
โ”œโ”€โ”€ Tools
โ”‚ย ย  โ”œโ”€โ”€ aux
โ”‚ย ย  โ””โ”€โ”€ src
โ””โ”€โ”€ aes

library-of-cheatsheets's People

Contributors

ledakatopodi 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.