batch_findltr.pl


NAME

batch_findltr.pl - Run the find_ltr.pl program in batch mode.


VERSION

This documentation refers to program version $Rev: 557 $


SYNOPSIS

Usage

    batch_findltr.pl -i InDir -o OutDir -c Config.cfg [--gff]

Required Arguments

    --indir         # Path to the input directory of fasta files
    --outdir        # Path to the base output directory
    --config        # Config file containg batch_findltr.pl paramaters
    --gff           # Produce GFF formatted output


DESCRIPTION

Runs the program find_ltr.pl in batch mode. This makes use of a modified version of the find_ltr.pl program that takes changes to the LTR finding parameters at the command line.


REQUIRED ARGUMENTS

-i,--indir

Path of the input directory. This is the directory that contains all of the fasta files to anlayze. The fasta files should all end with the fasta extension to recognized.

-o,--outdir

Path of the output directory. This is the base directory that will hold all of the batch_findltr.pl output

-c, --config

Path of the config file that contains the model options for running find_ltr. This config file is a white space delimited text file that should be in the following format.

  #---------------------------------------------------------------+
  #1   2     3     4      5     6     7      8     9   10         |
  #---------------------------------------------------------------+
  Def  40  1100  16000    40   100   1000   500  700   0.0000000001
  Alt  40  1100  1800     40   100   1000   500  400   0.00001

More information about this file is available under configuration and environment heading below.


OPTIONS

--fl-path

Location of the find_ltr.pl program. This option can also be set in the users envrionment. See Configuration and Environment below.

-q,--quiet

Run the program with minimal output.

-v, --verbose

Run the program in verbose mode.

--gff

Produce gff formatted output of the results.

--test

Run the program in test mode. The find_ltr.pl program will not be run, but the location of source files, binaries, will be checked and the outupt directories will be created.

--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.


DIAGNOSTICS

Error messages generated by this program and possible solutions are listed below.

ERROR: No fasta files were found in the input directory

The input directory does not contain fasta files in the expected format. This could happen because you gave an incorrect path or because your sequence files do not have the expected *.fasta extension in the file name.

ERROR: Could not create the output directory

The output directory could not be created at the path you specified. This could be do to the fact that the directory that you are trying to place your base directory in does not exist, or because you do not have write permission to the directory you want to place your file in.


CONFIGURATION AND ENVIRONMENT

Configuration File

The configuration file in batch_findltr.pl specifies the options for running the find_ltr.pl program. This is a white space delimited text file. All lines starting with the # symbol will be treated as comments. An example of a config file is below:

  #---------------------------------------------------------------+
  #1   2     3     4      5     6     7      8     9   10         |
  #---------------------------------------------------------------+
  Def  40  1100  16000    40   100   1000   500  700   0.0000000001
  Alt  40  1100  1800     40   100   1000   500  400   0.00001

These 10 columns represents the following information:

Col 1.

Base_name for the parameter set. This set name will be used to name the output file, and will be added to the output of the gff output file. DO NOT INCLUDE SPACES IN NAMES

Col 2.

Minimum Length MEM

Col 3.

Mimimum distance between MEMs

Col 4.

Maximum distance between MEMs

Col 5.

Maximu gap between MEMs

Col 6.

Minimum length of the LTR

Col 7.

Maximum length of the LTR

Col 8.

Range Bin

Col 9.

Minimum length of ORF

Col 10.

Mac E value of HMM Hit

FIND_LTR_PATH Environment

As an alternative to specifying the full path of the find_ltr program with the --fl-path option, the path of the find_ltr program can be specified in the users environment. For example in bash shell, add the following line to your .bashrc

  export FIND_LTR_PATH='/usr/local/genome/find_ltr.pl'

assuming that the find_ltr.pl program is in the /usr/local/genome/ directory.


DEPENDENCIES

Required Software

Required Perl Modules


BUGS AND LIMITATIONS

Bugs

Limitations


SEE ALSO

The batch_findltr.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.


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: 09/13/2007

UPDATED: 03/24/2009

VERSION: $Rev: 557 $

 batch_findltr.pl