batch_ltrfinder.pl


NAME

batch_ltrfinder.pl - Run the LTRFinder program in batch mode


VERSION

This documentation refers to program version $Rev: 558 $


SYNOPSIS

Usage

    batch_ltrfinder.pl -i InDir -o OutDir -c ConfigFile

Required Arguments

    -i,--indir    # Directory of fasta files to process
    -o,--outdir   # Path to the base output directory
    -c,--config   # Path to the config file


DESCRIPTION

This program will run the LTR_FINDER program for a set of fasta files. You can set multiple parameter sets using a config file.


REQUIRED ARGUMENTS

-i,--indir

Path of the directory containing the sequences to process.

-o,--outdir

Path of the directory to place the program output.

-c,--config

Path to the batch_ltrfinder config file. This is a tab delimited text file made up of two columns. The first column indicates the name assigned to the parameter set, while the second column contains the flags that will be passed to the LTR_FINDER program.


OPTIONS

--ltr-finder

Path to the LTR_FINDER binary.

-s,--trna-db

Path to the tRNA database used by LTR_FINDER. This file is part of the LTR_FINDER download.

-a,--prosite

Path to the prosite directory for use by LTR_FINDER.

-g,gff

Convert the outout to gff format.

-f,--feat-seq

Extract sequence string of features. These will be extracted as separate fasta files for each sequence feature class. These fasta files will be stored in the ltr_finder directory. Using rootname as the name of the contig and ltrid as the number assigned by LTR_Finder, the fasta files that are created are:

rootname_ltrid_ltr5.fasta

The sequence of the five prime LTR. This is not extracted from the alignment returned by LTR_Finder, but is extracted from the original sequence using the coordinates returned by LTR finder.

rootname_ltr3.fasta

The squence of the three primer LTR. This is also extracted from the original sequence using the coordinates returned by LTR finder.

rootname_ltr

The name of the individual LTR retrotransposon identified will be consistant across these fasta files. Not all

--usage

Short overview of how to use program from command line.

--help

Show program usage with summary of options.

--version

Show program version.

--man

Show the full program manual. This uses the perldoc command to print the POD documentation for the program.

--verbose

Run the program in verbose mode.

-q,--quiet

Run the program with minimal output.


DIAGNOSTICS

The list of error messages that can be generated, explanation of the problem one or more causes suggested remedies list exit status associated with each error


CONFIGURATION AND ENVIRONMENT

Configuration File

The location of the configuration file is indicated by the --config option at the command line. This is a tab delimited text file allowing you to run the LTR_FINDER program with multiple parameter sets for each query sequence file. This config file is a two column file. Lines beginning with the # symbol are ignored and provide a way to add comments to your config file. This config file is expected to have UNIX format line endings. You should therefore avoid creating config files using Windows based programs such as MS Word.

Col 1. Parameter set name

This is the name assigned to the parameter set defined on the current line. This name must not have any spaces. This name will be appended to the output gff file.

Col 2. LTR_FINDER Options

A string of command line options to send to the LTR finder program. For a full set of possible variables, see the LTR_FINDER User Manual http://tlife.fudan.edu.cn/ltr_finder/help/single.html

Example config file:

   # Simple batch_ltrfinder config file
   #
   def
   p_30 -p 30
   p_10 -p 10
   # END

User Environment

This program makes use of the following variables defined in the user's environment.

TRNA_DB

This is the path to TRNA_DB used by LTR_FINDER.

PROSITE_DIR

This is the path to the directory of Prosite models use by LTR_FINDER.

LTR_FINDER

This is the path to the LTR_FINDER binary.

Example environment variables set in the bash shell:

   export TRNA_DB='/home/yourname/apps/LTR_Finder/tRNAdb/Os-tRNAs.fa'
   export PROSITE_DIR='/home/yourname/Apps/LTR_Finder/ps_scan'
   export LTR_FINDER='ltr_finder'


DEPENDENCIES

Required Software

Required Perl Modules


SEE ALSO

The batch_ltrfinder.pl program is part of the DAWG-PAWS package of genome annotation programs. See the DAWG-PAWS web page ( http://dawgpaws.sourceforge.net/ ) or the Sourceforge project page ( http://sourceforge.net/projects/dawgpaws ) for additional information about this package.


BUGS AND LIMITATIONS

Bugs

Limitations


REFERENCE

A manuscript is being submitted describing the DAWGPAWS program. Until this manuscript is published, please refer to the DAWGPAWS SourceForge website when describing your use of this program:

JC Estill and JL Bennetzen. 2009. The DAWGPAWS Pipeline for the Annotation of Genes and Transposable Elements in Plant Genomes. http://dawgpaws.sourceforge.net/


LICENSE

GNU GENERAL PUBLIC LICENSE, VERSION 3

http://www.gnu.org/licenses/gpl.html


AUTHOR

James C. Estill <JamesEstill at gmail.com>


HISTORY

STARTED: 10/02/2007

UPDATED: 03/24/2009

VERSION: $Rev: 558 $

 batch_ltrfinder.pl