Skip to main content

Description

Append the minimap2's CS tag to SAM file.
If the CS tag is already present, this command will overwrite the existing tag.

⚠️ This tool will be maintained until the samtools team implements official CS caller.

Installation

You can install calcs using pip:

pip install calcs

Usage

calcs [options] <in.sam> -r/--reference <in.fasta>

Getting Started

# CS tag (short form)
calcs aln.sam -r ref.fasta > aln_cs.sam
# CS tag (long form)
calcs aln.sam -r ref.fasta -l > aln_cslong.sam
# PAF format with CS tag (short form)
calcs aln.sam -r ref.fasta -p > aln_cs.paf
# PAF format with CS tag (long form)
calcs aln.sam -r ref.fasta -p -l > aln_cslong.paf
# Multithreading
calcs aln.sam -r ref.fasta -t 4 > aln_cs.sam

Options

-l, --long: output the cs tag in  the long form
-t, --threads INT: number of threads to use (default: 1)

Examples

calcs examples/example.sam -r examples/ref.fa > example_cs.sam

If the input file is a BAM/CRAN format, you can use samtools view.

samtools view examples/example.bam |
  calcs -l -r examples/ref.fa |
  samtools sort > example_cslong.bam

paftools.js sam2paf vs calcs

sam2paf calcs
Speed + -
Report substitution + (if SAM includes MD tag) +
Report CS tag + (if SAM includes MD tag) +
Output format PAF SAM or PAF

Metadata

Release files for calcs 0.0.0.9999

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for calcs 0.0.0.9999
File Size Uploaded Provenance
calcs-0.0.0.9999.tar.gz 7.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for calcs 0.0.0.9999
File Interpreter ABI Platform
calcs-0.0.0.9999-py3-none-any.whl Python 3 none any Details

Total release size: 17.7 kB

Release files / calcs-0.0.0.9999.tar.gz

Download URL calcs-0.0.0.9999.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3cb00162204b1e05e3ab4c400c8bd6b7793b24834f18badc5396b119440689b3
BLAKE2b-256 checksum
How to use checksums
f4bbc6329f9ecd0125c11fdbbd71dd3ecd08feefe3a96ed8031cd624e56d7297
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / calcs-0.0.0.9999-py3-none-any.whl

Download URL calcs-0.0.0.9999-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
67942a66fa1680a91158d6c7db9695755a7567cf9629fc4b6338722c1ad1c82a
BLAKE2b-256 checksum
How to use checksums
0fa8dce6ad480566a0408912847c0c0b92b6504408fc2444819fd9f67ceee6ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/0.0.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Security for calcs 0.0.0.9999

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.0.9999 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page