clust_write_shell.pl


NAME

clust_write_shell.pl - Write shell scripts for the r cluster


VERSION

This documentation refers to fasta_dirsplit version $Rev: 617 $


SYNOPSIS

Usage

    clust_write_shell.pl -p program -o outdir -b job -n 16

Required Variables

    -p   # program to write the shell script for
    -o   # output dirctory to 
    -b   # base name for the shell scripts to write
    -n   # number of shell scripts to write
         # this will also be used to reference dirs


DESCRIPTION

Given information from the command line, write the shell scripts required to run jobs on cluster environments using the LSF queuing system.


REQUIRED ARGUMENTS

-p,--program

Program to write shell scripts for

-o,--outdir

Path of the directory to place the program output.

-n,--num-dir

Number of dirs to split the parent dir into.

-b, --base-name

Name to use a base name for creating the subdirectory


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.

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

--verbose

Run the program in verbose mode.


DIAGNOSTICS

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

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 currently rely on an external configuration file or variables set in the user's environment.


DEPENDENCIES

This program does not require external software, but the following Perl modules are required.

Required Perl Modules


BUGS AND LIMITATIONS

Bugs

Limitations


SEE ALSO

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

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: 07/26/2007

UPDATED: 04/06/2009

VERSION: $Rev: 617 $

 clust_write_shell.pl