Utility package to parse multi fasta files resulting from de novo assembly
Project description
# Contig Tools
## Installation
```
pip3 install contig-tools
```
## Usage
```
usage: contig-tools [-h] [-v] {filter,metrics,check_metrics} ...
A package to maniuplate and assess contigs arising from de novo assemblies
positional arguments:
{filter,metrics,check_metrics}
The following commands are available. Type
contig_tools <COMMAND> -h for more help on a specific
commands
filter Filter contigs based on either length and/or coverage
metrics Print contig metrics
check_metrics check contig metrics
optional arguments:
-h, --help show this help message and exit
-v, --version display the version number
```
## Examples
**filter contigs**
```
contig-tools filter -l 500 -c 3 -f contigs.fasta
```
**print contig metrics**
```
contig-tools metrics -f contig_tools/tests/test_data/test.fas
contig-tools metrics -f contig_tools/tests/test_data/test.fas -o json
```
**check if contigs meet conditions based on conditions enoded in a yaml file**
example yaml file
```
N50 score:
condition_type: gt
condition_value: 10
Largest contig:
condition_type: gt
condition_value: 15
Total length:
condition_type: lt_gt
condition_value:
- 100
- 50
```
example command
```
contig-tools check_metrics -f contigs.fasta -y conditions.yml
```
metrics that can be checked are
- Number of contigs
- Number of contigs > 500bp
- Total length
- %GC
- Largest contig
- N50 score
conditions that can be used are
- gt => greater than
- lt => less than
- lt_gt => less than and greater than
## code
Code can be found [here](https://gitlab.com/antunderwood/contig_tools)
## Installation
```
pip3 install contig-tools
```
## Usage
```
usage: contig-tools [-h] [-v] {filter,metrics,check_metrics} ...
A package to maniuplate and assess contigs arising from de novo assemblies
positional arguments:
{filter,metrics,check_metrics}
The following commands are available. Type
contig_tools <COMMAND> -h for more help on a specific
commands
filter Filter contigs based on either length and/or coverage
metrics Print contig metrics
check_metrics check contig metrics
optional arguments:
-h, --help show this help message and exit
-v, --version display the version number
```
## Examples
**filter contigs**
```
contig-tools filter -l 500 -c 3 -f contigs.fasta
```
**print contig metrics**
```
contig-tools metrics -f contig_tools/tests/test_data/test.fas
contig-tools metrics -f contig_tools/tests/test_data/test.fas -o json
```
**check if contigs meet conditions based on conditions enoded in a yaml file**
example yaml file
```
N50 score:
condition_type: gt
condition_value: 10
Largest contig:
condition_type: gt
condition_value: 15
Total length:
condition_type: lt_gt
condition_value:
- 100
- 50
```
example command
```
contig-tools check_metrics -f contigs.fasta -y conditions.yml
```
metrics that can be checked are
- Number of contigs
- Number of contigs > 500bp
- Total length
- %GC
- Largest contig
- N50 score
conditions that can be used are
- gt => greater than
- lt => less than
- lt_gt => less than and greater than
## code
Code can be found [here](https://gitlab.com/antunderwood/contig_tools)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
contig tools-0.2.3.tar.gz
(4.8 kB
view hashes)
Built Distribution
Close
Hashes for contig_tools-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f92164eacbdbac2403f7a926260b7a821d269cad4c772e9413e5e6dce7dc8b5 |
|
MD5 | 153e8eaec2def3d96adaea216e8c8349 |
|
BLAKE2b-256 | 9b3bc1351fe88ec7618a5394f10af2bcd282064730543044a915f20fe9de4510 |