Skip to main content

Pore_c_py

This package provides Python scripts for working with Pore-C data. It is not intended to be used directly by end uses, but rather as part of our Nextflow workflow wf-pore-c. Hence the terse nature of this documentation.

Installation

A package is available to install through either pip:

pip install pore-c-py

or through conda:

conda install -c nanoporetech pore-c-py

Usage

$ pore-c-py --help
usage: pore_c_py [OPTIONS] COMMAND [ARGS].

Available subcommands are:
    digest       Digest concatemer sequences into monomers using a restriction enzyme.      
    annotate     Annotate alignments with a "walk", which simply
                 enumerates the alignment coordinates of the monomers comprising the
                 concatemer.

Example

The following is indicative use, similar to that performed by wf-pore-c.

INPUT="myreads.bam"
ENZYME="NlaIII"
REF="myref.fasta"
OUTPUT="all"

pore-c-py digest "${INPUT}" "${ENZYME}" \
    | samtools fastq -T '*' \
    | minimap2 -ay -t 8 -x map-ont "${REF}" - \
    | pore-c-py annotate - "${OUTPUT}" --monomers --stdout --summary --chromunity \
    | tee "${OUTPUT}.ns.bam" \
    | samtools sort --write-index -o "${OUTPUT}.cs.bam" -
samtools index "${OUTPUT}.ns.bam"

The digest program can read its input from standard input, so it can be used with bamindex in order to process a subset of a file. This is particularly useful for distributing the workload on a cluster.

Metadata

Release files for pore-c-py 2.1.5

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

Source distribution (sdist)

Source distribution for pore-c-py 2.1.5
File Size Uploaded
pore_c_py-2.1.5.tar.gz 26.0 kB Details

Release files / pore_c_py-2.1.5.tar.gz

Download URL pore_c_py-2.1.5.tar.gz
Size 26.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1dd667c0bb1c6347b2b3af0d58b11fe53ddf4731103b6710478baaea171af889
BLAKE2b-256 checksum
How to use checksums
f020f0a7be1493f55eb470b708b2ea7abf947c786a3804a5c5b97f693bbee6c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.8.10

Release history Release notifications | RSS feed

This release

2.1.5 This release

1 release file

2.1.4

1 release file

2.1.3

1 release file

2.1.2

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.6

1 release file

2.0.5

1 release file

2.0.4

1 release file

2.0.3

1 release file

2.0.2

1 release file

2.0.1

1 release file

2.0.0

1 release file

1.0.0

1 release file

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