Metadata-Version: 2.1
Name: fastq-statistic
Version: 0.1.7
Summary: 
Home-page: https://github.com/maoyibo/fastq_statistic
License: GPL-3.0-or-later
Author: Mao Yibo
Author-email: maoyibo@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: matplotlib (>=3.3.3,<4.0.0)
Requires-Dist: numpy (>=1.19.5,<2.0.0)
Requires-Dist: pandas (>=1.2.1,<2.0.0)
Requires-Dist: typer (>=0.3.2,<0.4.0)
Description-Content-Type: text/markdown

Fastq Statistic
===============
Calculate statistics for Fastq Files.  

# Requirement
Python: 3.8 or upper  

# Install
Download the release whl file.  

```bash
user@linux:~$ python3 -m pip install fastq-statistic
```

# Usage
```bash
user@linux:~$ fastq-stat --help
Usage: fastq-stat [OPTIONS] READ1 [READ2]

Arguments:
  READ1    Read1 fastq path or fastq path  [required]
  [READ2]  Read2 filepath or None

Options:
  --sampleid TEXT                 SampleID, default is the first item of
                                  filename splited by underscore(_)

  --result PATH                   Result csv file name, plot with use the same
                                  name.

  --reserve-data / --no-reserve-data
                                  Reserve fastq statistic intermediate data.
                                  [default: False]

  --plot / --no-plot              Plot fastq statistic data.  [default: True]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.

  --help                          Show this message and exit.

```
