.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "GETCDS 1"
.TH GETCDS 1 2024-11-09 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
getcds.pl \- CDS extraction from various annotation formats
.SH SYNOPSIS
.IX Header "SYNOPSIS"
getcds.pl [options] input file [output file] [input file [outputfile] ...]
.SH OPTIONS
.IX Header "OPTIONS"
.Vb 3
\& Options include:
\&   redirect => Enable a redirect at runtime. explained below.
\&   force => allows writing empty .cds files
.Ve
.PP
If [output file] is unspecificied, "[input file].cds" is used.
.PP
There's lots of dark magic that can be performed with .redirect files.
Redirects are used to modify the ordinary behaviour and can be applied on
a global basis (a .redirect file in the same directory as [input file]), and/or
on a per-input basis ([input file].redirect). Redirects are read in that order
such that per-input effects are applied ontop of global effects.
.PP
If you've left the filename as-is from an Ensembl downoad, the appropriate
Ensembl DB source will be guessed automatically.
.PP
Possible redirects:
.IP "CDS \- changes what tag type is searched for when running on bioperl files (default is CDS)" 4
.IX Item "CDS - changes what tag type is searched for when running on bioperl files (default is CDS)"
.PD 0
.IP "offset \- add some value to all coordinates" 4
.IX Item "offset - add some value to all coordinates"
.IP "+bioperl \- on top of any other redirect-based data, also extract annotation via bioperl (using a direct disables bioperl's parser by default)" 4
.IX Item "+bioperl - on top of any other redirect-based data, also extract annotation via bioperl (using a direct disables bioperl's parser by default)"
.IP "ensembl_build \- grab data from the ensembl (in the specified schema)" 4
.IX Item "ensembl_build - grab data from the ensembl (in the specified schema)"
.IP "ucsc_build \- grab data from (in the specified schema)" 4
.IX Item "ucsc_build - grab data from (in the specified schema)"
.IP "murasaki_synth \- synthesize annotation data for each anchor from an alignment (if this is a directory, then each input file (eg input.lav) is checked for a corresponding .anchors file (eg. input.anchors)." 4
.IX Item "murasaki_synth - synthesize annotation data for each anchor from an alignment (if this is a directory, then each input file (eg input.lav) is checked for a corresponding .anchors file (eg. input.anchors)."
.IP "primary \- what to type of tags to create from data gathered from outside data (eg: ensembl, ucsc, or murasaki). default is the same as the cds redirect." 4
.IX Item "primary - what to type of tags to create from data gathered from outside data (eg: ensembl, ucsc, or murasaki). default is the same as the cds redirect."
.IP "chromosome \- forces a specific chromosome rather than deriving from filename" 4
.IX Item "chromosome - forces a specific chromosome rather than deriving from filename"
.IP "gtf \- extract annotation from a .gtf file" 4
.IX Item "gtf - extract annotation from a .gtf file"