Commit ff3e6b2f authored by Sebastien Moretti's avatar Sebastien Moretti
Browse files

Update doc for new cache mgmt

parent 7a874457
......@@ -12,29 +12,26 @@ use warnings;
use diagnostics;
use Carp;
use File::Which qw(which); # Locate external executable programs in the PATH
use Time::localtime; # Use localtime+PID for a pseudo-uniq temp file name
use Getopt::Long; # Options specifications
use File::Copy qw(move); # Avoid external 'mv' command usage
use LWP::Simple; # To test gigablaster availability
use File::Which qw(which); # Locate external executable programs in the PATH
use Time::localtime; # Use localtime+PID for a pseudo-uniq temp file name
use Getopt::Long; # Options specifications
use File::Copy qw(move); # Avoid external 'mv' command usage
use LWP::Simple; # To test gigablaster availability
use Mail::Send; # Send warnings and errors files by e-mail ==> only if the $userEMail variable is defined
use Mail::Send; # Send warnings and errors files by e-mail ==> only if the $userEMail variable is defined
use lib '/mnt/common/share/ProtoGene/'; # Local path for ProtoGene's own perl modules
#use lib '/mnt/local/lib/tcoffee_perl/';
use Exonerate; # Exonerate runner, parser, ...
use Views; # Non-text outputs, e.g. HTML/CSS
#use CheckOutput; # Check output for cds consistancy with query
use lib '/mnt/common/share/ProtoGene/'; # Local path for ProtoGene's own perl modules
use Exonerate; # Exonerate runner, parser, ...
use Views; # Non-text outputs, e.g. HTML/CSS
#use CheckOutput; # Check output for cds consistancy with query
################## CONFIGURATION ##################
#$ENV{'PATH'} .= ':/mnt/local/bin/:./'; # Additional path for executables
my $cachePath = '/scratch/fhgfs/tcoffee/ProtoGene_Cache'; # Cache directory
my $cacheStorageTime = 15; # Do not update sequences younger than X days
my $cachePath = '/scratch/fhgfs/tcoffee/ProtoGene_Cache'; # Cache directory
my $cacheStorageTime = 15; # Do not update sequences younger than X days
my $userEMail = 'moretti.sebastien@gmail.com'; # To receive e-mails with encountered problems; leave blank to inactive
my $userEMail = 'moretti.sebastien@gmail.com'; # To receive e-mails with encountered problems; leave blank to inactive
### BLAST parameters ###
my $blast_param = { 'evalue' => 0.05,
......@@ -63,9 +60,10 @@ my $exonerate_exe = 'exonerate'; # Exonerate 1.0 because current parser on
################## Option management
my ($msa, $revtrans, $pep, $hideBOJ, $run_name, $template, $lim, $cache) = ('', 0, 0, 0, '', '', 0, 'update');
my ($debug, $tmp) = (0, 0);
my ($db, $species, $local, $giga) = ($blast_param->{'db1'}, $blast_param->{'species'}, 0, 0);
my ($msa, $revtrans, $pep, $hideBOJ, $run_name, $template, $lim) = ('', 0, 0, 0, '', '', 0);
my ($cache, $cleancache) = ('update', 'update');
my ($debug, $tmp) = (0, 0);
my ($db, $species, $local, $giga) = ($blast_param->{'db1'}, $blast_param->{'species'}, 0, 0);
my %opts = ('msa|in=s' => \$msa, # Input sequences
'revtrans:s' => \$revtrans, # Use to reverse-translate sequences with no match
'pep' => \$pep, # Add the original peptide query beneath the related CDS seq
......@@ -73,7 +71,8 @@ my %opts = ('msa|in=s' => \$msa, # Input sequences
'run_name=s' => \$run_name, # Use another name, instead of input seq name, for result files
'template=s' => \$template, # Use a template file
'lim=i' => \$lim, # Limit number of input query sequences
'cache=s' => \$cache, # Cache behavior
'cachedir=s' => \$cache, # Cache directory
'cacheclean=s' => \$cleancache, # Cache behavior
'orgm|species=s' => \$species, # Organism(s) to blast against
'db|database=s' => \$db, # Database to blast against
......@@ -98,29 +97,30 @@ if ( !$test_option_values || ($msa eq '' && $cache ne 'empty' && $cache ne 'old'
print {*STDERR} "\n\tCannot open the MSA file in FASTA format
\tTry: $0 --msa=path_of_the_fasta_msa_file [Options]
\tOptions: --orgm=All_organisms, Bacteria, Viruses, Vertebrata,
\t Eukaryota, Mammalia, Primates, Homo_sapiens,
\t Gallus_gallus, Bos_taurus, Escherichia_coli,
\t Arabidopsis_thaliana, Mus_musculus,
\t Drosophila_Melanogaster, ...
\t default is '$blast_param->{'species'}'
\t --db=nr, pdb, swissprot, refseq_protein
\t default is '$blast_param->{'db1'}'
\t --local to execute a local BLAST query with
\t --db=path_for_a_local_db_blast_formated\n
\t --template to provide your own nucleotidic sequences
\t following the cds file format
\t --revtrans reverse-translates sequences with no
\t blast hit, in IUB (IUPAC) depiction code
\t They are removed from the alignement by default
\t --pep adds the original peptide query beneath the
\t back-translated sequence
\t --cache=none, update, use, 'own_PATH_directory', old, empty
\t to select the cache mode
\t default is 'update'\n
\t --debug prints extra information when running
\t --version prints version information
\t --help prints a full help message\n\n";
\tOptions: --orgm =All_organisms, Bacteria, Viruses, Vertebrata,
\t Eukaryota, Mammalia, Primates, Homo_sapiens,
\t Gallus_gallus, Bos_taurus, Escherichia_coli,
\t Arabidopsis_thaliana, Mus_musculus,
\t Drosophila_Melanogaster, ...
\t default is '$blast_param->{'species'}'
\t --db =nr, pdb, swissprot, refseq_protein
\t default is '$blast_param->{'db1'}'
\t --local to execute a local BLAST query with
\t --db=path_for_a_local_db_blast_formated\n
\t --template to provide your own nucleotidic sequences
\t following the cds file format
\t --revtrans reverse-translates sequences with no
\t blast hit, in IUB (IUPAC) depiction code
\t They are removed from the alignement by default
\t --pep adds the original peptide query beneath the
\t back-translated sequence
\t --cachedir ='own_PATH_directory'
\t (default is '$cachePath')
\t --cacheclean=none, update, use, old, empty
\t to select the cache behavior (default is 'update')\n
\t --debug prints extra information when running
\t --version prints version information
\t --help prints a full help message\n\n";
exit(1);
}
......@@ -508,7 +508,13 @@ with these options available:
=item I<--pep> to add the original peptide query beneath the back-translated sequence
=item I<--cache>=none, update, use, own_path_directory, old, empty
=item I<--cachedir>=your_own_path_directory
=item cachedir sets cache directory
=item I<--cacheclean>=none, update, use, old, empty
=item cacheclean manages cache behavior
=item none: no cache usage, none temporary files are stored
......@@ -516,8 +522,6 @@ with these options available:
=item use: force use cache, whatever the age of files
=item own_path_directory: use my own directory, and its files
=item old: remove the old files in the cache directory
=item empty: empty completely the cache directory
......@@ -548,7 +552,7 @@ PROTOGENE re-builds the original alignment with nucleotidic information it has g
=item -
=item I<exonerate> from http://www.ebi.ac.uk/~guy/exonerate/
=item I<exonerate> version 2 from http://www.ebi.ac.uk/~guy/exonerate/
=item I<blast> from http://www.ncbi.nlm.nih.gov/BLAST/download.shtml or http://blast.wustl.edu/
......@@ -558,9 +562,9 @@ PROTOGENE re-builds the original alignment with nucleotidic information it has g
=over 8
=item version 4.2.0
=item version 4.2.1
=item on Aug 08th, 2013
=item on Dec 18th, 2013
=back
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment