semvec/pypi-packages huggingface dataset:
vp-cli 0.1.12
VantagePoint CLI
Requires Python: >=3.7

# vp_cli
[![vp-cli](https://github.com/corsis-tech/vp-cli/actions/workflows/build-vp-cli.yml/badge.svg)](https://github.com/corsis-tech/vp-cli/actions/workflows/build-vp-cli.yml)

Command Line interface for VantagePoint

## Installation and Documentation
The full documentation is available [here](https://vantagepointsecurity.gitlab.io/platform-components/utilities/vp_cli)

## Development
- In-container development environment

```console
$ make shell
```
Use [.env](https://gitlab.com/vantagepointsecurity/platform-components/utilities/vp_cli/-/blob/staging/.env) file to set development environment

- To install cli (Also works inside development container)
```console
$ make install
```

- Running tests
```console
$ tox
```
Use `tox.ini` to set the test environment [here](https://gitlab.com/vantagepointsecurity/platform-components/utilities/vp_cli/-/blob/staging/tox.ini#L4)

- To build `.deb`, `.rpm` and `.tar.gz` packages

```console
$ make build_all
```
This will build and place the artifacts in `build` dir

- To build and push to artifactory
```
$ make release
```

- To clean up and uninstall cli

```console
$ make clean
```

- Documentation

Updates to documentation are made in the [docs](https://gitlab.com/vantagepointsecurity/platform-components/utilities/vp_cli/-/tree/staging/docs) directory.
To generate html
```console
$ cd docs
$ make html # this will generate html in the docs/build dir
```
plasIDome 1.0.0
A tool to detect plasmids and contamination in bacterial and archaeal genome assemblies
Requires Python: >=3.6

# PlasIDome
A tool to detect plasmids and contamination in bacterial and archaeal genome assemblies

## Introduction
In bacterial genome assembly, it is important to account for all of the contigs. PlasIDome finds all contigs in an assembly file that are less than a specified length (default: 200,000bp) and uses sequences homology to categorize each as chromosomal, plasmid, or contamination. With this tool a key step in assessing assembly quality has been automated and can be integrated into existing workflows.


## Getting Started
### Requirements
* python 3.7+
* blast+ 2.10.1+
* bioseq

### Installation
PlasIDome is available on PYPI and can be installed using pip
``` pip install plasIDome ```


## Usage
As input, PlasIDome takes a genome assembly file in fasta format (.fasta, .fa, .fna).

Example:

``` plasidome -b path/to/blastn -f genome.fasta ```


Examine contigs up to 50,000 bp in length:

``` plasidome -b path/to/blastn -f genome.fasta -l 50000 ```


Extensive Usage:

``` plasidome -b path/to/blastn -f genome.fasta -p path/to/output -o output_name ```



## Output Files
PlasIDome generates three outputs:
* report.tsv
* alignment_results.tsv
* directory of contigs

The report.tsv file contains a summary of the alignment results in table format. From left to right, the table includes the contig name, its classification, and its contamination status followed by the number of matches that were to chromosomal, plasmid, undetermined, or human sequences in the database.

A file called alignment_results.tsv is created that contains the raw, uninterpreted alignment results in table format. From left to right, the table includes the contig name, subject name, subject taxonomic ID, the percent sequence identity, query coverage, qcovhsp, alignment length, and e-value. The raw data allows the investigator to parse the alignment results manually. The alignment results written to this file are limited to homology matches where the subject and query shared at least 95% sequence identity and the subject covered at least 95% of the length of the length of the query sequence. 

FASTA files with each contig sequence are saved to a subdirectory called single_contigs so the user can re-align any sequence without having to find and isolate the contig themselves.

At this time, PlasIDome is not able to determine if a plasmid is complete or if multiple contigs are fragments of the same plasmid. PlasIDome also does not comment on the taxonomic identification of the species. If the user wants to see the taxonomic makeup of the sample, it is best to review the raw alignment results in the alignment_results.tsv file.