Git Product home page Git Product logo

cgsl-scripts's Introduction

CGSL-scripts

Coding Best Practices

  • Each directory should contain the following structure
    • Script.sh (This should be renamed to something that is intuitive)

      • This should be the only script in this directory
      • Running this script without options (or -h) should display an infromative usage statement with clear descriptions of all variables
      • Any optional arguments that are needed in ancillary scripts must be captured here
    • scripts/

      • Any script that is needed to support the primary wrapper should be placed here
    • images/

      • This is where you should put any images you need for this website
      • We may want to rename this to be outputs so that we can keep example output files
    • config/

    • Should contain at least 1 file named config.cfg

    • This is where you should define all of the tool paths necessary to run all the script

      • An example would look like this:
              JAVA_PATH=/biotools/biotools/java/jdk1.7.0_72/bin
              BEDTOOLS_PATH=/usr/local/biotools/bedtools/2.20.1/bin
              VCFLIB_PATH=/usr/local/biotools/vcflib/2015_3_20/bin
              GATK_PATH=/biotools/biotools/gatk/3.3.0
              REF_GENOME=/dlmp/misc-data/reference/ggpsReferences/genomes/withMT/hs37d5.chr.fa
              R_PATH=/usr/local/biotools/r/3.1.1/bin

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.