cnv_ltrstruc2gff.pl


NAME

cnv_ltrstruc2gff.pl - Convert LTR_STRUC report output files to gff


VERSION

This documentation refers to program version $Rev: 596 $


SYNOPSIS

Usage

    cnv_ltrstruc2gff.pl -i InDir -o OutDir -r LStrucOut

Required Arguments

    --indir         # Directory with the fasta files
                    # This is used to find the root seq names
    --outdir        # Directory for the base output dir
    --results       # Directory containing the LTR_STRUC results


DESCRIPTION

Given a directory containing the output from LTR_STRUC and a directory containing the fasta files that the structural predictions were made from,


REQUIRED ARGUMENTS

-i,--indir

Path of the intput directory containing the fasta files that were analyzed by LTR_STRUC. It may seem awkward to need to provide this directory of fasta files, but it is currently necessary to be able to find the reports for that sequence set. LTR_Struc does not provide the sequence name in a format that can be parsed. Furthermore, LTR_struc does not provide the location of the sequence features on the sequence file, so the fasta file is needed to map the LTR retrotransposon model back onto the sequence file.

-o,--outdir

Path of the output directory that will serve as the base for the output from the conversion to gff. Every sequence will have a subdirectory created in this parent dir.

-r,--results

Path of the directory containing the results from LTR_STRUC. It is expected that these file names will end with rprt.txt.


OPTIONS

--program

Specify the program name to use in the GFF output file. By default, the program name used is ltr_sturc

--param

Specify the parameter set name to used. This will be appended to the program name in the source column of the gff output file.

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


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

The program cnv_ltrstruc2gff.pl does not currently require an external configuration file or make use of variables defined in the user's environment.


DEPENDENCIES

Required Software

Required Perl Modules


BUGS AND LIMITATIONS

Bugs


SEE ALSO

The cnv_ltrstruc2gff.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/25/2007

UPDATED: 03/24/2009

VERSION: $Rev: 596 $

 cnv_ltrstruc2gff.pl