batch_game2gff.pl


VERSION

This documentation refers to program version $Rev: 371 $


SYNOPSIS

Usage

    batch_game2gff.pl -i InDir -o OutDir

Required Variables

    --indir         # Path to the input directory
    --outdir        # Path to the output directory


DESCRIPTION

This is what the program does


REQUIRED ARGUMENTS

-i,--indir
Path to the directory that contains the game.xml files to be converted from game.xml format to gff format.

-o,--outfile
Path to the output directory where the GFF format files will be saved to.


OPTIONS

--ap-path
The path to the local installation of the Apollo Genome Annotation program. This can also be defined with the GP_APOLLO_BIN environment variable as discussed in the CONFIGURATION AND ENVIRONMENT section of the batch_game2gff.pl program manual.

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

--verbose
Run the program in verbose mode. This produces the maximum amount of program status information and can be useful for diagnosing problems.


DIAGNOSTICS

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

ERROR: No game.xml files were found in the input directory
The input directory does not appear to contain game.xml files. This could happen because you gave an incorrect path or because your annotation files do not have the expected *.game.xml 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

This program does not require external configuration files but it can make use of variables defined in the user's environment:

User Environment

DP_APOLLO_BIN
This is the path to the Apollo binary file. This can also be defined at the command line by the --ap-path variable.

An example of setting the Apollo binary variable in the bash shell is:

    export DP_APOLLO_BIN='$HOME/apps/Apollo_1.6.5/apollo/bin/apollo'


DEPENDENCIES

Required Software

Required Perl Modules


BUGS AND LIMITATIONS

Bugs

Limitations


SEE ALSO

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


LICENSE

GNU General Public License, Version 3

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

THIS SOFTWARE COMES AS IS, WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. USE AT YOUR OWN RISK.


AUTHOR

James C. Estill <JamesEstill at gmail.com>


HISTORY

STARTED: 11/01/2007

UPDATED: 12/17/2007

VERSION: $Rev: 371 $

 batch_game2gff.pl