~ubuntu-branches/ubuntu/quantal/genometools/quantal-backports

'\" t

.\"     Title: gt-extractfeat

.\"    Author: [see the "AUTHOR" section]

.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>

.\"      Date: 07/11/2012

.\"    Manual: \ \&

.\"    Source: \ \&

.\"  Language: English

.\"

.TH "GT\-EXTRACTFEAT" "1" "07/11/2012" "\ \&" "\ \&"

.\" -----------------------------------------------------------------

.\" * Define some portability stuff

.\" -----------------------------------------------------------------

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.\" http://bugs.debian.org/507673

.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html

.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.ie \n(.g .ds Aq \(aq

.el       .ds Aq '

.\" -----------------------------------------------------------------

.\" * set default formatting

.\" -----------------------------------------------------------------

.\" disable hyphenation

.nh

.\" disable justification (adjust text to left margin only)

.ad l

.\" -----------------------------------------------------------------

.\" * MAIN CONTENT STARTS HERE *

.\" -----------------------------------------------------------------

.SH "NAME"

gt-extractfeat \- Extract features given in GFF3 file from sequence file\&.

.SH "SYNOPSIS"

.sp

gt extractfeat [option \&...] [GFF3_file]

.SH "OPTIONS"

.PP

\fB\-type\fR

.RS 4

set type of features to extract (default: undefined)

.RE

.PP

\fB\-join\fR

.RS 4

join feature sequences in the same subgraph into a single one (default: no)

.RE

.PP

\fB\-translate\fR

.RS 4

translate the features (of a DNA sequence) into protein (default: no)

.RE

.PP

\fB\-seqid\fR

.RS 4

add sequence ID of extracted features to FASTA descriptions (default: no)

.RE

.PP

\fB\-target\fR

.RS 4

add target ID(s) of extracted features to FASTA descriptions (default: no)

.RE

.PP

\fB\-seqfile\fR

.RS 4

set the sequence file from which to extract the features (default: undefined)

.RE

.PP

\fB\-seqfiles\fR

.RS 4

set the sequence files from which to extract the features use

\fI\-\-\fR

to terminate the list of sequence files

.RE

.PP

\fB\-matchdesc\fR

.RS 4

match the sequence descriptions from the input files for the desired sequence IDs (in GFF3) (default: no)

.RE

.PP

\fB\-usedesc\fR

.RS 4

use sequence descriptions to map the sequence IDs (in GFF3) to actual sequence entries\&. If a description contains a sequence range (e\&.g\&., III:1000001\&.\&.2000000), the first part is used as sequence ID (\fIIII\fR) and the first range position as offset (\fI1000001\fR) (default: no)

.RE

.PP

\fB\-regionmapping\fR

.RS 4

set file containing sequence\-region to sequence file mapping (default: undefined)

.RE

.PP

\fB\-v\fR

.RS 4

be verbose (default: no)

.RE

.PP

\fB\-width\fR

.RS 4

set output width for FASTA sequence printing (0 disables formatting) (default: 0)

.RE

.PP

\fB\-o\fR

.RS 4

redirect output to specified file (default: undefined)

.RE

.PP

\fB\-gzip\fR

.RS 4

write gzip compressed output file (default: no)

.RE

.PP

\fB\-bzip2\fR

.RS 4

write bzip2 compressed output file (default: no)

.RE

.PP

\fB\-force\fR

.RS 4

force writing to output file (default: no)

.RE

.PP

\fB\-help\fR

.RS 4

display help and exit

.RE

.PP

\fB\-version\fR

.RS 4

display version information and exit

.RE

.SH "DESCRIPTION"

.sp

File format for option \-regionmapping:

.sp

The file supplied to option \-regionmapping defines a \(lqmapping\(rq\&. A mapping maps the sequence\-regions given in the GFF3_file to a sequence file containing the corresponding sequence\&. Mappings can be defined in one of the following two forms:

.sp

mapping = { chr1 = "hs_ref_chr1\&.fa\&.gz", chr2 = "hs_ref_chr2\&.fa\&.gz" }

.sp

or

.sp

function mapping(sequence_region) return "hs_ref_"\&.\&.sequence_region\&.\&."\&.fa\&.gz" end

.sp

The first form defines a Lua (http://www\&.lua\&.org/) table named \(lqmapping\(rq which maps each sequence region to the corresponding sequence file\&. The second one defines a Lua function \(lqmapping\(rq, which has to return the sequence file name when it is called with the sequence_region as argument\&.

.SH "AUTHOR"

.sp

Report bugs to <gt\-users@genometools\&.org>\&.