eukfindertest2 1.0.1

A small demo package

Eukfinder

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g
  

Installation

(back to top)

Usage

Eukfinder read_prep usage: Eukfinder read_prep [-h] --r1 R1 --r2 R2 -n THREADS -i ILLUMINA_CLIP --hcrop HCROP -l LEADING_TRIM -t TRAIL_TRIM --wsize WSIZE --qscore QSCORE --mlen MLEN --hg HG -o OUT_NAME --cdb CDB

optional arguments: -h, --help show this help message and exit

Required arguments: Description

--r1 R1, --reads-r1 R1 left reads

--r2 R2, --reads-r2 R2 right reads

-n THREADS, --threads THREADS number of threads

-i ILLUMINA_CLIP, --illumina-clip ILLUMINA_CLIP adaptor file

--hcrop HCROP, --head-crop HCROP head trim

-l LEADING_TRIM, --leading-trim LEADING_TRIM leading trim

-t TRAIL_TRIM, --trail-trim TRAIL_TRIM trail trim

--wsize WSIZE, --window-size WSIZE sliding window size

--qscore QSCORE, --quality-score QSCORE quality score for trimming

--mlen MLEN, --min-length MLEN minimum length

--hg HG, --host-genome HG host genome to get map out

-o OUT_NAME, --out_name OUT_NAME out name

--cdb CDB, --centrifuge-database CDB path to centrifuge database

Roadmap

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Acknowledgments

(back to top)