Skip to main content

Command line interface of cstag to manipulate the minimap2's CS tag

Project description

Licence Test Python PyPI Bioconda DOI

cstag-cli

cstag-cli is a command-line tool of cstag for manipulating minimap2's CS tags.

🌟Features

  • cstag append: Appends CS tags to a SAM/BAM file

🛠 Installation

Using PyPI:

pip install cstag-cli

Using Bioconda:

conda install -c bioconda cstag-cli

💡Usage

Append CS tags to a SAM/BAM file

cstag append [-f/--file] [-l/--long]
  • -f/--file: Specifies the path to a SAM/BAM file. If no file is provided, it reads from standard input. An MD tag is required in the SAM/BAM file.
  • -l/--long: Outputs CS tags in the long format

Examples

  • To append CS tags in the short format:
cstag append -f tests/append/data/example.bam > example_cs_short.sam
  • To append CS tags in the long format:
cstag append -f tests/append/data/example.bam -l > example_cs_long.sam
  • Reading data from standard input:
cat tests/append/data/example.bam | cstag append > example_cs_short.sam

📣Feedback

For questions, bug reports, or any other inquiries, feel free to reach out! Please use GitHub Issues for reporting.

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

cstag-cli-0.1.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

cstag_cli-0.1.1-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

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