Skip to main content

ZSeeker is a cli tool to find the propensity of B-DNA to form Z-DNA structures.

Project description

ZDNA tool

Installation

pip install ZSeeker

CLI Usage

ZSeeker --fasta ./test_GCA_f.fasta --n_jobs 1

Example: In Code usage

from zseeker.zdna_calculator import ZDNACalculatorSeq, Params
# Define parameters
params = Params(
    GC_weight=5.0,
    AT_weight=0.5,
    GT_weight=1.1,
    AC_weight=1.3,
    mismatch_penalty_starting_value=4,
    mismatch_penalty_linear_delta=2,
    mismatch_penalty_type='linear',
    threshold=10,
    consecutive_AT_scoring=[1, 2, 2],
    display_sequence_score=1
)

# Create a ZDNACalculatorSeq instance and nput sequence
zdna_calculator = ZDNACalculatorSeq(data="ACGTACGTACGT", params=params)

# Calculate subarrays above threshold
subarrays = zdna_calculator.subarrays_above_threshold()

# Print results
print(subarrays)

Command-line Help

usage: ZSeeker [-h] [--fasta FASTA] [--GC_weight GC_WEIGHT]
               [--AT_weight AT_WEIGHT] [--GT_weight GT_WEIGHT]
               [--AC_weight AC_WEIGHT]
               [--mismatch_penalty_starting_value MISMATCH_PENALTY_STARTING_VALUE]
               [--mismatch_penalty_linear_delta MISMATCH_PENALTY_LINEAR_DELTA]
               [--mismatch_penalty_type {linear,exponential}]
               [--n_jobs N_JOBS] [--threshold THRESHOLD]
               [--consecutive_AT_scoring CONSECUTIVE_AT_SCORING]
               [--display_sequence_score {0,1}]
               [--output_dir OUTPUT_DIR]

Given a fasta file and the corresponding parameters it calculates the
ZDNA for each sequence present.

options:
  -h, --help            show this help message and exit
  --fasta FASTA         Path to file analyzed
  --GC_weight GC_WEIGHT
                        Weight given to GC and CG transitions.
                        Default = 7.0
  --AT_weight AT_WEIGHT
                        Weight given to AT and TA transitions.
                        Default = 0.5
  --GT_weight GT_WEIGHT
                        Weight given to GT and TG transitions.
                        Default = 1.25
  --AC_weight AC_WEIGHT
                        Weight given to AC and CA transitions.
                        Default = 1.25
  --mismatch_penalty_starting_value MISMATCH_PENALTY_STARTING_VALUE
                        Penalty applied to the first non
                        purine/pyrimidine transition encountered.
                        Default = 3
  --mismatch_penalty_linear_delta MISMATCH_PENALTY_LINEAR_DELTA
                        Only applies if penalty type is set to
                        linear. Determines the rate of increase of
                        the penalty for every subsequent non
                        purine/pyrimidine transition. Default = 3
  --mismatch_penalty_type {linear,exponential}
                        Method of scaling the penalty for contiguous
                        non purine/pyrimidine transition. Default =
                        linear
  --n_jobs N_JOBS       Number of threads to use. Defaults to -1,
                        which uses the maximum available threads on
                        CPU
  --threshold THRESHOLD
                        Scoring threshold for a for a sequence to be
                        considered potentially Z-DNA forming and
                        returned by the program. This parameter is
                        also used for determining how big the scoring
                        drop within a sequence should be, before it
                        is split into two separate Z-DNA candidate
                        sequences. Default=50
  --consecutive_AT_scoring CONSECUTIVE_AT_SCORING
                        Consecutive AT repeats form a hairpin
                        structure instead of Z-DNA. In order to
                        reflect that, a penalty array is defined,
                        which provides the score adjustment for the
                        first and the subsequent TA appearances. The
                        last element will be applied to every
                        subsequent TA appearance. For more
                        information see documentation. Default =
                        (0.5, 0.5, 0.5, 0.5, 0.0, 0.0, -5.0, -100.0)
  --display_sequence_score {0,1}
  --output_dir OUTPUT_DIR

Example output file

Chromosome,Start,End,Z-DNA Score,Sequence
Z1,0.0,15.0,87.0,TGCGTGCGCGCGCGCG
Z2,0.0,15.0,87.0,GCGCCCGCGCGCGCGC
Z3,0.0,11.0,71.0,GCGCGCGCGCGT
Z4,0.0,11.0,65.0,GCGCGTGCGCGC
Z5,0.0,10.0,70.0,CGCGCGCGCGC
Z6,0.0,15.0,63.0,GCACGCACACGCGCGT
Z7,0.0,10.0,70.0,GCGCGCGCGCG
Z8,0.0,13.0,61.0,CGCACGCGCACGCA
Z9,0.0,11.0,59.0,CGCGCGCGCACA

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

zseeker-1.4.tar.gz (22.1 kB view details)

Uploaded Source

Built Distribution

ZSeeker-1.4-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

Details for the file zseeker-1.4.tar.gz.

File metadata

  • Download URL: zseeker-1.4.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.15

File hashes

Hashes for zseeker-1.4.tar.gz
Algorithm Hash digest
SHA256 e42e558bfb36a48c3bd7b3fceb167ee3618c36862e82f6eed205d849eb76731c
MD5 d6d86e42d56d776d01dfd5d371a9af10
BLAKE2b-256 d6f3cad776289576c41d607d374f02a9ab17111a8b2f167f6816d4d5e7d129ad

See more details on using hashes here.

File details

Details for the file ZSeeker-1.4-py3-none-any.whl.

File metadata

  • Download URL: ZSeeker-1.4-py3-none-any.whl
  • Upload date:
  • Size: 23.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.15

File hashes

Hashes for ZSeeker-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 972a161ea21e5ef2e3068797b00c14c0f9ba5f8ffd1285c92e9a3d106d9d1910
MD5 0773adbc1459877e336ba236573556a6
BLAKE2b-256 d75c5d2be79ac94d74d9e1c5d646aa3e86798d0a9c444897690da14345a20f78

See more details on using hashes here.

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