Skip to main content

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)

Project details


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 details)

Uploaded Source

Built Distribution

contig_tools-0.2.3-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file contig tools-0.2.3.tar.gz.

File metadata

  • Download URL: contig tools-0.2.3.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

File hashes

Hashes for contig tools-0.2.3.tar.gz
Algorithm Hash digest
SHA256 f3fbd22385f2619d43bfd69533730da5c070f6d1b47a4822ae8dd903420889cb
MD5 3425b81cf50e53f1ce4dca4693222313
BLAKE2b-256 e60e5fe01ae35739ffa7d9bdbd68974ccfbf5c09718b3085765ea6a24ac025ff

See more details on using hashes here.

File details

Details for the file contig_tools-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: contig_tools-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

File hashes

Hashes for contig_tools-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8f92164eacbdbac2403f7a926260b7a821d269cad4c772e9413e5e6dce7dc8b5
MD5 153e8eaec2def3d96adaea216e8c8349
BLAKE2b-256 9b3bc1351fe88ec7618a5394f10af2bcd282064730543044a915f20fe9de4510

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page