https://github.com/stjudecloud/bioinformatics-tool-template

https://github.com/stjudecloud/bioinformatics-tool-template

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/stjudecloud/bioinformatics-tool-template
• Owner: stjudecloud
• License: mit
• Created: 2020-11-14T03:14:00.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-27T15:01:32.000Z (over 3 years ago)
• Last Synced: 2025-01-22T05:28:49.268Z (over 1 year ago)
• Language: Dockerfile
• Size: 14.6 KB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          


  


    [PROJECT NAME]

  


  


   

     

   

   

     

   

   

     

   

   

     

   

  


  


   [PROVIDE A HIGH LEVEL DESCRIPTION OF YOUR PROJECT] 

   


   Explore the docs »

   


   Read the paper »

   


   


   Request Feature

    | 

   Report Bug

   


    ⭐ Consider starring the repo! ⭐

   


  


---

## Quick Start

How can a user get the project up and running in the shortest amount of time? Docker is a good tool for this if the project supports it.

### Docker

Example deployment if project supports Docker.

### Developers Build

Example of how to manually build the project

#### Dependencies

List external dependencies here that the install process assumes are installed prior to beginning.

## Usage 

Explain how to use the tool here.  Dive into the subcommands and optional flags.  Give examples of the tool running and what a successful execution might look like.

### Contact

Provide contact information if the author of the code chooses to.  Issues are another effective way of communication as well.

#### Limitations

Are there any know limits to the tool.  Some examples of this might be:

  - Does not run on OSX

  - Version 1.2 of library XYZ causes `this` unexpected behavior

---

#### COPYRIGHT 

Provide St Jude Copyright information here.  Make sure to update the year.