/bioinformatics-tool-template

Primary LanguageDockerfileMIT LicenseMIT

[PROJECT NAME]

Status Github Issues Pull Requests License: MIT

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