batch_findgaps.pl


NAME

batch_findgaps.pl - Annotate gaps in a fasta file


VERSION

This documentation refers to batch_findgaps version $Rev: 581 $


SYNOPSIS

Usage

    batch_findgaps.pl -i DirToProcess -o OutDir

Required Arguments

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


DESCRIPTION

Runs the RepeatMasker program for a set of input FASTA files against a set of repeat library files & then converts the repeat masker *.out file into the GFF format and then to the game XML format for visualization by the Apollo genome anotation program.


REQUIRED ARGUMENTS

-i,--indir

Path of the directory containing the sequences to process.

-o,--outdir

Path of the directory to place the program output.


OPTIONS

--logfile

Path to a file that will be used to log program status. If the file already exists, additional information will be concatenated to the existing file.

--gapchar

The character that is treated as the gap character. B By default this is N. This option takes a single character as its argument.

--len

The minimum gap length. This option takes a integer as its option.

--game

Use this option to generate a game xml file of the output. This option requires that you have apollo on your local machine since the program uses apollo to translate from gff to game xml.

--ap-path

Specify the path to your local installation of apollo.

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

-q,--quiet

Run the program with minimal output.

--test

Run the program without doing the system commands.


DIAGNOSTICS

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

No configuration files or environmental variables are required to use this program.


DEPENDENCIES

Required Software

Apollo

This program requires the Apollo Genome Annotation Curation tool to convert the gff output to the game.xml format. This can be obtained at http://apollo.berkeleybop.org/current/index.html. While Apollo is used to convert to game.xml, the batch_findgaps.pl program can be used without apollo to generate gff foramt files.

Required Perl Modules


BUGS AND LIMITATIONS

Bugs

Limitations


SEE ALSO

The batch_findgaps.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: 08/01/2007

UPDATED: 09/29/2008

VERSION: $Rev: 581 $

 batch_findgaps.pl