Repository navigation
Expand file tree
/
Copy pathRepeatMaskerConfig.pm
More file actions
515 lines (483 loc) · 18.2 KB
/
Copy pathRepeatMaskerConfig.pm
File metadata and controls
515 lines (483 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
#!/usr/bin/perl
##---------------------------------------------------------------------------##
## File:
## @(#) RepeatMaskerConfig.pm
## Author:
## Robert Hubley <rhubley@systemsbiology.org>
## Arian Smit <asmit@systemsbiology.org>
## Description:
## This is the main configuration file for the RepeatMasker
## program suite. Before you can run the programs included
## in this package you will need to edit this file either
## through the use of the configure script ( preferred ) or
## by hand-editing this file.
##
#******************************************************************************
#* Copyright (C) Institute for Systems Biology 2005-2019 Developed by
#* Arian Smit and Robert Hubley.
#*
#* This work is licensed under the Open Source License v2.1. To view a copy
#* of this license, visit http://www.opensource.org/licenses/osl-2.1.php or
#* see the license.txt file contained in this distribution.
#*
###############################################################################
package RepeatMaskerConfig;
use FindBin;
use File::Basename;
use Data::Dumper;
require Exporter;
@EXPORT_OK = qw();
%EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
@ISA = qw(Exporter);
my $CLASS = "RepeatMaskerConfig";
BEGIN {
##----------------------------------------------------------------------##
## CONFIGURE THE FOLLOWING PARAMETERS FOR YOUR INSTALLATION ##
## ##
## This file may be hand edited or preferably, modified with the ##
## the use of the "configure" script. ##
## ##
## In the following section default values for paths/programs ##
## may be hardcoded. Each parameter appears in a block of text ##
## below as: ##
## ##
## PARAMETER_NAME => { ##
## ... ##
## value => "/usr/local/bin/foo" ##
## } ##
## ##
## only change the "value" field for each parameter. If you are ##
## unsure of how to edit this file, simply use the the ./configure ##
## script provided with the package to perform the same task. For ##
## more details on configuring this package please see the README ##
## file. ##
## ##
## STCFG --do-not-remove--
$configuration = {
'ABBLAST_DIR' => {
'command_line_override' => 'abblast_dir',
'description' => 'The path to the installation of the ABBLAST sequence alignment program.',
'environment_override' => 'ABBLAST_DIR',
'expected_binaries' => [
'xdformat',
'blastp'
],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => ''
},
'CACHE_DIR' => {
'command_line_override' => 'cache_dir',
'description' => 'Where to keep the species libraries built from FamDB, searched before the Libraries directory and ~/.RepeatMaskerCache. Created if missing. Leave blank to use those defaults.',
'environment_override' => 'REPEATMASKER_CACHE_DIR',
'param_type' => 'value',
'required' => 0,
'value' => ''
},
'CROSSMATCH_DIR' => {
'command_line_override' => 'crossmatch_dir',
'description' => 'The path Phil Green\'s cross_match program ( phrap program suite ).',
'environment_override' => 'CROSSMATCH_DIR',
'expected_binaries' => [
'cross_match'
],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => '/usr/local/phrap'
},
'DEFAULT_SEARCH_ENGINE' => {
'command_line_override' => 'default_search_engine',
'description' => 'The default search engine to use',
'param_type' => 'value',
'required' => 1,
'value' => 'rmblast'
},
'FAMDB_DATA_DIR' => {
'command_line_override' => 'famdb_data_dir',
'description' => 'The directory holding the FamDB data (*.h5) files. Passed to famdb.py as -i. Leave blank to use FamDB\'s own default (famdb.conf, or Libraries/famdb beside famdb.py).',
'environment_override' => 'FAMDB_DATA_DIR',
'expected_binaries' => [],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => ''
},
'FAMDB_DIR' => {
'command_line_override' => 'famdb_dir',
'description' => 'The path to the installation of the FamDB package (famdb.py).',
'environment_override' => 'FAMDB_DIR',
'expected_binaries' => [
'famdb.py'
],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => '/usr/local/FamDB-Dfam-4.0'
},
'HMMER_DIR' => {
'command_line_override' => 'hmmer_dir',
'description' => 'The path to the HMMER profile HMM search software.',
'environment_override' => 'HMMER_DIR',
'expected_binaries' => [
'nhmmer'
],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => '/usr/local/hmmer/bin'
},
'RMBLAST_DIR' => {
'command_line_override' => 'rmblast_dir',
'description' => 'The path to the installation of the RMBLAST sequence alignment program.',
'environment_override' => 'RMBLAST_DIR',
'expected_binaries' => [
'rmblastn'
],
'expected_files' => [],
'param_type' => 'directory',
'required' => 0,
'value' => '/usr/local/rmblast-2.17.1/bin'
},
'TRF_PRGM' => {
'command_line_override' => 'trf_prgm',
'description' => 'The full path including the name for the TRF program.',
'environment_override' => 'TRF_PRGM',
'param_type' => 'program',
'required' => 1,
'value' => '/usr/local/bin/trf'
}
};
## EDCFG --do-not-remove--
## ##
## END CONFIGURATION AREA ##
##----------------------------------------------------------------------##
##----------------------------------------------------------------------##
## Do not edit below this line ##
##----------------------------------------------------------------------##
#
# Current version of the software
#
$VERSION = "4.2.6";
#
# Default Dfam Version
#
$DFAM_VERSION = "4.0";
#
# Set this flag to default to debug mode for the entire package
#
$DEBUGALL = 0;
#
# Prompt for a specific parameter and update the object
#
sub promptForParam{
my $param = shift;
my $screenHdr = shift;
if ( ! exists $configuration->{$param} ) {
return;
}
# Grab defaults
my $defaultValue;
if ( $configuration->{$param}->{'param_type'} eq "directory" )
{
if ( exists $configuration->{$param}->{'expected_binaries'} &&
@{$configuration->{$param}->{'expected_binaries'}} )
{
my $binary = $configuration->{$param}->{'expected_binaries'}->[0];
$defaultValue = `/usr/bin/which $binary`;
if ( $defaultValue !~ /\/usr\/bin\/which:/ )
{
$defaultValue =~ s/[\n\r\s]+//g;
$defaultValue =~ s/^(.*)\/$binary/$1/;
}else {
$defaultValue = "";
}
}
if ( $defaultValue eq "" && exists $configuration->{$param}->{'value'} &&
-d $configuration->{$param}->{'value'} ) {
$defaultValue = $configuration->{$param}->{'value'};
}
}elsif ( $configuration->{$param}->{'param_type'} eq "program" )
{
# The program type is used in cases where a single
# script/binary is referenced and may not have the
# exact name we expect. TRF is a good example of this
# as the binary is often distributed with names like:
# trf409.linux64 etc..
if ( exists $configuration->{$param}->{'value'} ) {
my($binary, $dirs, $suffix) = fileparse($configuration->{$param}->{'value'});
$defaultValue = `/usr/bin/which $binary`;
if ( $defaultValue !~ /\/usr\/bin\/which:/ )
{
$defaultValue =~ s/[\n\r\s]+//g;
}else {
$defaultValue = $configuration->{$param}->{'value'};
}
}
}
my $value = "";
my $validParam;
do {
$validParam = 1;
system("clear");
if ( $screenHdr ) {
print "$screenHdr\n";
}else {
print "\n\n\n\n";
}
print "" . $configuration->{$param}->{'description'} . "\n";
# Prompt and get the value
if ( $defaultValue ) {
print "$param [$defaultValue]: ";
}else {
print "$param: ";
}
$value = <STDIN>;
$value =~ s/[\n\r]+//g;
if ( $value eq "" && $defaultValue )
{
$value = $defaultValue;
}
if ( $configuration->{$param}->{'param_type'} eq "directory" )
{
if ( -d $value ) {
foreach my $file ( @{$configuration->{$param}->{'expected_files'}} )
{
if ( ! -s "$value/$file" )
{
print "\nCould not find the required file \"$file\" inside\n"
. "the directory \"$value\"!\n\n";
$validParam = 0;
last;
}
}
foreach my $binary ( @{$configuration->{$param}->{'expected_binaries'}} )
{
if ( ! -x "$value/$binary" )
{
print "\nCould not find the required program \"$binary\" inside\n"
. "the directory \"$value\"!\n\n";
$validParam = 0;
last;
}elsif ( -d "$value/$binary" )
{
print "\nCould not find the required program \"$binary\" inside\n"
. "the directory \"$value\"! It appears to be the name of a\n"
. "subdirectory.\n\n";
$validParam = 0;
last;
}
}
}else {
print "\nCould not find the \"$value\" directory.\n\n";
$validParam = 0;
}
}elsif ( $configuration->{$param}->{'param_type'} eq "program" )
{
if ( ! -x $value ) {
print "\nThe program \"$value\" doesn't appear to exist\n"
. "or it's not executable!\n\n";
$validParam = 0;
}elsif ( -d $value ){
print "\nThe value \"$value\" appears to be a directory rather\n"
. "than an executable binary or script!\n\n";
$validParam = 0;
}
}
if ( $validParam == 0 )
{
print "<PRESS ENTER TO CONTINUE, CTRL-C TO BREAK>\n";
<STDIN>;
}
}while ( $validParam == 0 );
$configuration->{$param}->{'value'} = $value;
}
#
# Validate parameter
#
sub validateParam{
my $param = shift;
my $new_setting = shift;
if ( ! exists $configuration->{$param} ) {
return 0;
}
my $value = $configuration->{$param}->{'value'};
$value = $new_setting if ( defined $new_setting );
# Always assume the "good" in parameters...
my $validParam = 1;
if ( $configuration->{$param}->{'param_type'} eq "directory" )
{
if ( -d $value ) {
foreach my $file ( @{$configuration->{$param}->{'expected_files'}} )
{
if ( ! -s "$value/$file" )
{
$validParam = 0;
last;
}
}
foreach my $binary ( @{$configuration->{$param}->{'expected_binaries'}} )
{
if ( ! -x "$value/$binary" )
{
$validParam = 0;
last;
}elsif ( -d "$value/$binary" )
{
$validParam = 0;
last;
}
}
}else {
$validParam = 0;
}
}elsif ( $configuration->{$param}->{'param_type'} eq "program" )
{
if ( ! -x $value ) {
$validParam = 0;
}elsif ( -d $value ){
$validParam = 0;
}
}
return $validParam;
}
#
# Clear all settings
#
sub clearValues{
foreach my $param ( keys %$configuration ) {
if ( $configuration->{$param}->{'value'} )
{
$configuration->{$param}->{'value'} = '';
}
}
&updateConfigFile();
}
#
# Update this file ( beware: self modifying code ) new
# paramter settings.
#
sub updateConfigFile{
open IN,"<$CLASS.pm" or die;
open OUT,">new-$CLASS.pm" or die;
my $inCfg;
$Data::Dumper::Sortkeys = 1;
while (<IN>){
if ( /##\s+STCFG/ ) {
$inCfg = 1;
print OUT;
my $cStr = Dumper($configuration);
$cStr =~ s/\$VAR1/ \$configuration/;
print OUT "$cStr\n";
}elsif ( /##\s+EDCFG/ ) {
$inCfg = 0;
print OUT;
}elsif ( ! $inCfg ) {
print OUT;
}
}
close IN;
close OUT;
rename("$CLASS.pm", "$CLASS.pm.bak");
rename("new-$CLASS.pm", "$CLASS.pm");
}
#
# Create a GetOpt list for the command-line parameters defined
# in this configuration file. These may be appended to a program's
# existing GetOpt parameter as:
#
# push @getopt_args, RepeatMaskerConfig::getCommandLineOptions();
#
sub getCommandLineOptions {
my @options = ();
foreach my $param ( keys %$configuration ) {
if ( exists $configuration->{$param}->{'command_line_override'} ) {
push @options, "-" . $configuration->{$param}->{'command_line_override'} . "=s";
}
}
return @options;
}
#
# Get POD documentation to add to the existing program POD stored in
# the main script.
#
sub getPOD {
my $pod_str;
foreach my $param ( sort keys %$configuration ) {
if ( exists $configuration->{$param}->{'command_line_override'} ) {
$pod_str .= "=item -" . $configuration->{$param}->{'command_line_override'} . " <string>\n\n";
$pod_str .= $configuration->{$param}->{'description'};
$pod_str .= " May also be set with the "
. $configuration->{$param}->{'environment_override'}
. " environment variable."
if ( exists $configuration->{$param}->{'environment_override'} );
$pod_str .= "\n\n";
}
}
if ( $pod_str ) {
return( "\n=over 4\n\n" . $pod_str . "=back\n\n" );
}
return;
}
#
# After GetOpt has filled in the options hash simply pass it to
# this function to perform resolution. The following precedence
# is used:
#
# 1. Command Line Parameter
# 2. Environment Variable
# 3. Configuration File
#
# This will update the configuration{param}->{'value'} for use
# in the main program.
#
sub resolveConfiguration {
my $options = shift;
foreach my $param ( keys %$configuration ) {
if ( exists $options->{$configuration->{$param}->{'command_line_override'}} )
{
$configuration->{$param}->{'value'} = $options->{$configuration->{$param}->{'command_line_override'}};
} elsif ( exists $ENV{$configuration->{$param}->{'environment_override'}} )
{
$configuration->{$param}->{'value'} = $ENV{$configuration->{$param}->{'environment_override'}};
}
}
}
#
# The famdb.py command to run, ready for a shell, after
# resolveConfiguration(). Adds "-i <dir>" when FAMDB_DATA_DIR is set so
# every caller reads the same FamDB data. Append the subcommand and its
# arguments, e.g. famdbProgram() . " info".
#
sub famdbProgram {
my $famdbDir = $configuration->{'FAMDB_DIR'}->{'value'} // "";
my $dataDir = $configuration->{'FAMDB_DATA_DIR'}->{'value'} // "";
my $cmd = "$famdbDir/famdb.py";
if ( $dataDir ne "" ) {
( my $quoted = $dataDir ) =~ s/'/'"'"'/g;
$cmd .= " -i '$quoted'";
}
return $cmd;
}
#
# Directories to look in for cached libraries, in order, after
# resolveConfiguration(). New caches are written to the first writable
# one. CACHE_DIR (if set) comes first, then the installation's Libraries
# directory ($libDir), then ~/.RepeatMaskerCache.
#
sub cacheSearchPath {
my $libDir = shift;
my @path = ();
my $cacheDir = $configuration->{'CACHE_DIR'}->{'value'} // "";
if ( $cacheDir ne "" ) {
$cacheDir =~ s/\/+$//;
push @path, $cacheDir;
}
push @path, $libDir;
push @path, $ENV{'HOME'} . "/.RepeatMaskerCache"
if ( defined $ENV{'HOME'} && $ENV{'HOME'} ne "" );
return @path;
}
}
1;