Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 1.67 KB

README.md

File metadata and controls

87 lines (52 loc) · 1.67 KB
Raw

My Package


This is a great package


Package logo

Package information

  • Author(s): Name author(s)
  • Organization: Rijksinstituut voor Volksgezondheid en Milieu (RIVM)
  • Department: Infektieziekteonderzoek, Diagnostiek en Laboratorium Surveillance (IDS), Bacteriologie (BPD)
  • Start date: 00 - 00 - 0000

About this package

Short description of the pipeline.

Prerequisities

  • Python 3.10.0 or higher

Installation

  1. Clone the repository.
git clone [link]
  1. Go to [name] directory.
cd [directory name]
  1. Continue steps

Parameters & Usage

Command for help

  • -h, --help Shows help.

Required parameters

  • -p, --parameter Explanation of the parameter

Optional parameters

  • -o, --optional_parameter Explanation of the parameter

The base command to run this program from the command-line

python3 my_package/main.py -p [parameter]

An example on how to run the pipeline.

[insert command here]

Detailed information about the pipeline can be found in the [documentation](link to other docs).

Explanation of the output

Explanation.

Issues

Known issues Go to the Issues section in this repo.

Future ideas

Place to store future ideas.

License

This package is licensed with a AGPL3 license. Detailed information can be found inside the 'LICENSE' file in this repository.

Contact

Contact person: Alejandra Hernández Segura Email: [email protected]