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 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
|
#include <CLI11.hpp>
#include "src/Options.h"
#include "src/VeryFastTree.h"
#include "src/Utils.h"
#include <cmath>
#include <bxzstr.hpp>
std::string isNotEmpty(const std::string &input) {
if (input.size() == 0) {
return "Value is empty";
}
return std::string();
}
struct Min : CLI::Validator {
template<typename T>
Min(T min, bool equals = true) {
func = [min, equals](std::string input) {
T val;
CLI::detail::lexical_cast(input, val);
if (val < min)
return "Min value " + std::to_string(min);
if (!equals && val == min)
return "Min value greater than " + std::to_string(min);
return std::string();
};
}
};
void setDeprecated(CLI::Option *op) {
op->check([&op](const std::string &in) {
std::cerr << "Warning: " << op->get_name() << " is a deprecated option and it has no effect" << std::endl;
return "";
});
}
void cli(CLI::App &app, std::string &name, std::string &version, std::string &flags, veryfasttree::Options &options,
std::vector<std::string> &args) {
std::stringstream description;
std::string padd = std::string(name.size() + 1, ' ');
description << name << " " << version << " " << flags << std::endl;
description << name << " [-nt] [-n 100] [-quote] [-pseudo | -pseudo 1.0]" << std::endl;
description << padd << "[-boot 1000 | -nosupport]" << std::endl;
description << padd << "[-intree starting_trees_file | -intree1 starting_tree_file]" << std::endl;
description << padd << "[-quiet | -nopr]" << std::endl;
description << padd << "[-nni 10] [-spr 2] [-noml | -mllen | -mlnni 10]" << std::endl;
description << padd << "[-mlacc 2] [-cat 20 | -nocat] [-gamma]" << std::endl;
description << padd << "[-slow | -fastest] [-2nd | -no2nd] [-slownni] [-seed 1253]" << std::endl;
description << padd << "[-top | -notop] [-topm 1.0 [-close 0.75] [-refresh 0.8]]" << std::endl;
description << padd << "[-gtr] [-gtrrates ac ag at cg ct gt] [-gtrfreq A C G T]" << std::endl;
description << padd << "[ -lg | -wag | -trans transitionmatrixfile ]" << std::endl;
description << padd << "[-matrix Matrix | -nomatrix] [-nj | -bionj]" << std::endl;
description << padd << "[ -constraints constraintAlignment [ -constraintWeight 100.0 ] ]" << std::endl;
description << padd << "[-log logfile]" << std::endl;
description << padd << "[ alignment_file ]" << std::endl;
description << padd << "[ -threads 1 ] [ -threads-level 3 [ -threads-ptw 20 ] [-threads-verbose]" << std::endl;
description << padd << "[ -double-precision ] [ -ext AUTO ] [ -fastexp 0 ]" << std::endl;
description << padd << "[ -disk-computing ] [ -disk-computing-path ./ ] [ -disk-dynamic-limit inf ]" << std::endl;
description << padd << "[ -relative-progress ]" << std::endl;
description << padd << "[ -out output_newick_file | > newick_tree]" << std::endl;
description << std::endl;
description << name << " [-nt] [-matrix Matrix | -nomatrix] [-rawdist] -makematrix [alignment]" << std::endl;
description << padd << "[-n 100] > phylip_distance_matrix" << std::endl;
description << std::endl;
description << " VeryFastTree supports NEXUS, Fasta, Fastq or Phylip interleaved formats" << std::endl;
description << " VeryFastTree supports files compressed with ZLib and libBZ2" << std::endl;
description << " By default VeryFastTree expects protein alignments, use -nt for nucleotides" << std::endl;
description << " VeryFastTree reads standard input if no alignment file is given" << std::endl;
app.name(name);
app.description(description.str());
app.set_help_flag("-h,-help,--help")->group("");
app.add_option("protein_alignment", options.inFileName,
"input file instead of stdin.")->
type_name("")->check(isNotEmpty);
auto io = "Input/output options";
app.add_option("-out", options.outFileName,
"print tree in output file instead of stdout")->type_name("file")->
check(isNotEmpty)->group(io);
app.add_option("-n", options.nAlign,
"read in multiple alignments in. This only works with phylip interleaved format. For example,"
" you can use it with the output from phylip's seqboot. If you use -n, VeryFastTree will write 1"
" tree per line to standard output.")->type_name("<number>")->check(Min(1))->group(io);
app.add_flag_function("-nt", [&options](size_t) {
options.nCodes = 4;
},
"nucleotides instead of protein alignments")->group(io);
app.add_option("-intree", options.intreeFile,
"read the starting tree in from newickfile. Any branch lengths in the starting trees are ignored."
" -intree with -n will read a separate starting tree for each alignment. "
"Use * or *name to read the tree in from the NEXUS block trees.")->
type_name("newick_file")->check(isNotEmpty)->group(io);
app.add_option("-intree1", options.intreeFile, "read the same starting tree for each alignment")->
type_name("newick_file")->check(isNotEmpty)->check([&options](const std::string &) {
options.intree1 = true;
return "";
})->group(io);
app.add_option("-verbose", options.verbose, "level of details during normal operation")->type_name("lvl")->
group(io);
app.add_flag_function("-quiet", [&options](size_t) {
options.verbose = 0;
options.showProgress = false;
},
"do not write to standard error during normal operation (no progress indicator, no options"
" summary, no likelihood values, etc.)")->group(io);
app.add_flag_function("-nopr", [&options](size_t) {
options.showProgress = false;
}, "do not write the progress indicator to stderr")->group(io);
app.add_option("-log", options.logFileName,
"save intermediate trees so you can extract the trees and restart long-running jobs if they crash"
" -log also reports the per-site rates (1 means slowest category)")->type_name("logfile")->
check(isNotEmpty)->group(io);
app.add_flag_function("-quote", [&options](size_t) {
options.bQuote = true;
},
"quote sequence names in the output and allow spaces, commas, parentheses, and colons in them"
" but not ' characters (fasta files only)")->group(io);
std::stringstream dist_description;
dist_description << "Distances:" << std::endl;
dist_description << " Default: For protein sequences, log-corrected distances and an" << std::endl;
dist_description << " amino acid dissimilarity matrix derived from BLOSUM45" << std::endl;
dist_description << " or for nucleotide sequences, Jukes-Cantor distances" << std::endl;
dist_description << " To specify a different matrix, use -matrix FilePrefix or -nomatri" << std::endl;
dist_description << " Use -rawdist to turn the log-correction off" << std::endl;
dist_description << " or to use %different instead of Jukes-Cantor" << std::endl;
dist_description << " (These options affect minimum-evolution computations only;" << std::endl;
dist_description << " use -trans to affect maximum-likelihoood computations)" << std::endl;
dist_description << " or for nucleotide sequences, Jukes-Cantor distances" << std::endl;
auto dist = dist_description.str();
app.add_flag_function("-makematrix", [&options](size_t) { options.makeMatrix = true; },
"print distance matrix")->group(dist);
app.add_flag_function("-rawdist", [&options](size_t) { options.logdist = false; }, "to turn the log-correction off")
->group(dist);
app.add_option("-matrix", options.matrixPrefix, "to specify a different matrix")->type_name("file")->
check(isNotEmpty)->group(dist);
app.add_flag_function("-nomatrix", [&options](size_t) { options.useMatrix = false; },
"use %different as the uncorrected distance")->type_name("file")->check(
isNotEmpty)->group(dist);
app.add_option("-pseudo", [&args, &options](CLI::results_t in) {
if (std::find(args.begin(), args.end(), "-pseudo") != args.end()) {
if (!CLI::detail::lexical_cast(in[0], options.pseudoWeight)) {
throw CLI::ConversionError(in[0], "-pseudo");
}
}
return true;
},
"Use pseudocounts to estimate distances between sequences with little or no overlap. "
"(Off by default.) Recommended if analyzing the alignment has sequences with little or no overlap."
" If the weight is not specified, it is 1.0")->add_result("1.0")->
multi_option_policy(CLI::MultiOptionPolicy::TakeLast)->check(Min(0.0))->group(dist);
std::stringstream topo_description;
topo_description << "Topology refinement:" << std::endl;
topo_description << " By default, VeryFastTree tries to improve the tree with up to 4*log2(N)" << std::endl;
topo_description << " rounds of minimum-evolution nearest-neighbor interchanges (NNI)," << std::endl;
topo_description << " where N is the number of unique sequences, 2 rounds of" << std::endl;
topo_description << " subtree-prune-regraft (SPR) moves (also min. evo.), and" << std::endl;
topo_description << " up to 2*log(N) rounds of maximum-likelihood NNIs." << std::endl;
auto topo = topo_description.str();
app.add_option("-nni", options.nni, "to set the number of rounds of min. evo. NNIs")->group(topo);
app.add_option("-spr", options.spr, "to set the rounds of SPRs")->group(topo);
app.add_flag_function("-noml", [&options](size_t) {
options.MLnni = 0;
},
"to turn off both min-evo NNIs and SPRs (useful if refining an approximately "
"maximum-likelihood tree with further NNIs)")->group(topo);
app.add_option("-sprlength", options.maxSPRLength, "set the maximum length of a SPR move (default 10)")->
group(topo);
app.add_option("-mlnni", options.MLnni, "to set the number of rounds of maximum-likelihood NNIs")->
group(topo);
app.add_option("-mlacc", options.mlAccuracy, "Use -mlacc 2 or -mlacc 3 to always optimize all 5 branches at each"
" NNI, and to optimize all 5 branches in 2 or 3 rounds")->
check(Min(1))->group(topo);
app.add_flag_function("-mllen", [&options](size_t) {
options.MLnni = 0;
options.MLlen = true;
},
"to optimize branch lengths without ML NNIs. Use -mllen -nome with -intree to optimize"
" branch lengths on a fixed topology ")->group(topo);
app.add_flag_function("-approxml,-mlapprox", [&options](size_t) {
options.exactML = false;
},
"approximate posterior distributions for a.a.s")->group(topo);
app.add_flag_function("-slownni", [&options](size_t) {
options.fastNNI = false;
},
"to optimize branch lengths without ML NNIs")->group(topo);
auto model = "Maximum likelihood model options";
app.add_flag_function("-lg", [&options](size_t) {
options.bUseLg = true;
}, "Le-Gascuel 2008 model instead of (default) Jones-Taylor-Thorton 1992 model (a.a. only)")->group(model);
app.add_flag_function("-wag", [&options](size_t) {
options.bUseWag = true;
}, "Whelan-And-Goldman 2001 model instead of (default) Jones-Taylor-Thorton 1992 model (a.a. only)")->group(model);
app.add_flag_function("-gtr", [&options](size_t) {
options.bUseGtr = true;
}, "generalized time-reversible instead of (default) Jukes-Cantor (nt only)")->group(model);
app.add_option("-gtrrates", [&args, &options](CLI::results_t in) {
options.bUseGtr = true;
options.bUseGtrRates = true;
for (size_t i = 0; i < in.size(); i++) {
if (!CLI::detail::lexical_cast(in[i], options.gtrrates[i])) {
throw CLI::ConversionError(in[i], "-gtrrates");
}
}
return true;
}, " set the gtr rates")->check(Min(1e-5))->type_size(-1)->expected(6)->group(model);
app.add_option("-gtrfreq", [&args, &options](CLI::results_t in) {
options.bUseGtr = true;
options.bUseGtrFreq = true;
double sum = 0;
for (size_t i = 0; i < in.size(); i++) {
if (!CLI::detail::lexical_cast(in[i], options.gtrfreq[i])) {
throw CLI::ConversionError(in[i], "-gtrfreq");
}
sum += options.gtrrates[i];
}
if (std::fabs(1.0 - sum) > 0.01) {
throw CLI::ValidationError("-gtrfreq", "values do not sum to 1");
}
for (size_t i = 0; i < in.size(); i++) {
options.gtrfreq[i] /= sum;
}
return true;
}, " set the gtr frequences")->check(Min(1e-5))->type_size(-1)->expected(4)->group(model);
app.add_option("-cat", options.nRateCats, "specify the number of rate categories of sites (default 20)")->
type_name("n")->check(Min(1))->group(model);
app.add_flag_function("-nocat", [&options](size_t) {
options.nRateCats = 1;
}, "no CAT model (just 1 category)")->group(model);
app.add_option("-trans", options.transitionFile,
"use the transition matrix from filename."
"This is supported for amino acid alignments only."
"The file must be tab-delimited with columns in the order ARNDCQEGHILKMFPSTWYV*."
"The additional column named * is for the stationary distribution."
"Each row must have a row name in the same order ARNDCQEGHILKMFPSTWYV")->
type_name("filename")->group(model);
app.add_flag_function("-gamma", [&options](size_t) {
options.gammaLogLk = true;
},
"after the final round of optimizing branch lengths with the CAT model, report the likelihood"
" under the discrete gamma model with the same number of categories. VeryFastTree uses the same"
" branch lengths but optimizes the gamma shape parameter and the scale of the lengths. "
"The final tree will have rescaled lengths. Used with -log, this also generates per-site"
" likelihoods for use with CONSEL, see GammaLogToPaup.pl and documentation on the VeryFastTree"
" web site.")->group(model);
std::stringstream support_description;
support_description << "Support value options:" << std::endl;
support_description << " By default, VeryFastTree computes local support values by resampling the site"
<< std::endl;
support_description << " likelihoods 1,000 times and the Shimodaira Hasegawa test. If you specify -nome,"
<< std::endl;
support_description << " it will compute minimum-evolution bootstrap supports instead" << std::endl;
support_description << " In either case, the support values are proportions ranging from 0 to 1" << std::endl;
auto support = support_description.str();
app.add_flag_function("-nome", [&options](size_t) {
options.spr = 0;
options.nni = 0;
},
"to compute minimum-evolution bootstrap supports")->group(support);
app.add_flag_function("-nosupport", [&options](size_t) {
options.nBootstrap = 0;
}, "to turn off support values")->group(support);
app.add_option("-boot", options.nBootstrap, "to use just n resamples")->type_name("n")->group(support);
app.add_flag_function("-noboot", [&options](size_t) {
options.nBootstrap = 0;
},
"to no use resamples")->group(support);
app.add_option("-seed", options.seed, "to initialize the random number generator")->type_name("n")->group(support);
std::stringstream search_description;
search_description << "Searching for the best join:" << std::endl;
search_description << " By default, VeryFastTree combines the 'visible set' of fast neighbor-joining "
<< std::endl;
search_description << " with local hill-climbing as in relaxed neighbor-joining" << std::endl;
auto search = search_description.str();
app.add_flag_function("-slow", [&options](size_t) {
options.slow = true;
},
"exhaustive search (like NJ or BIONJ, but different gap handling) -slow takes half an hour"
" instead of 8 seconds for 1,250 proteins")->group(search);
app.add_flag_function("-fastest", [&options](size_t) {
options.fastest = true;
options.tophitsRefresh = 0.5;
options.useTopHits2nd = true;
},
"search the visible set (the top hit for each node) only Unlike the original fast"
" neighbor-joining, -fastest updates visible(C) after joining A and B if join(AB,C)"
" is better than join(C,visible(C)) -fastest also updates out-distances in a very lazy way,"
" -fastest sets -2nd on as well, use -fastest -no2nd to avoid this")->
group(search)->excludes("-slow");
std::stringstream heuristics_description;
heuristics_description << "Top-hit heuristics:" << std::endl;
heuristics_description << " By default, VeryFastTree uses a top-hit list to speed up search" << std::endl;
auto heuristics = heuristics_description.str();
app.add_flag_function("-top", [&options](size_t) {
if (options.tophitsMult < 0.01) {
options.tophitsMult = 1.0;
}
return true;
}, "set the top-hit list size to 1.0 if it is less than 0.01")->group(heuristics);
app.add_flag_function("-notop", [&options](size_t) {
options.tophitsMult = 0.0;
},
"(or -slow) to turn this feature off and compare all leaves to each other, and all new "
"joined nodes to each other")->group(heuristics);
app.add_option("-topm", options.tophitsMult,
"set the top-hit list size to parameter*sqrt(N) VeryFastTree estimates the"
" top m hits of a leaf from the top 2*m hits of a 'close' neighbor,"
" where close is defined as d(seed,close) < 0.75 * d(seed, hit of rank"
" 2*m), and updates the top-hits as joins proceed")->type_name("1.0")->
group(heuristics);
app.add_option("-close", options.tophitsClose, "modify the close heuristic, lower is more conservative")->
type_name("0.75")->check([&options](const std::string &in) {
if (options.tophitsMult <= 0) {
return "Cannot use -close unless -top is set above 0";
}
if (options.tophitsClose <= 0 || options.tophitsClose >= 1) {
return "-close argument must be between 0 and 1";
}
return "";
})->group(heuristics);
app.add_option("-refresh", options.tophitsRefresh,
"compare a joined node to all other nodes if its top-hit list is "
"less than 80% of the desired length, or if the age of the top-hit"
" list is log2(m) or greater")->type_name("0.8")->
check([&options](const std::string &in) {
if (options.tophitsMult <= 0) {
return "Cannot use -refresh unless -top is set above 0";
}
if (options.tophitsRefresh <= 0 || options.tophitsRefresh >= 1) {
return "-refresh argument must be between 0 and 1";
}
return "";
})->group(heuristics);
app.add_flag_function("-2nd", [&options](size_t) { options.useTopHits2nd = true; },
"to turn 2nd-level top hits heuristic on. This reduces memory usage and running time but may"
" lead to marginal reductions in tree quality. (By default, -fastest turns on -2nd.)")->
group(heuristics);
app.add_flag_function("-no2nd", [&options](size_t) { options.useTopHits2nd = false; },
"to turn 2nd-level top hits heuristic off.")->group(heuristics);
auto join = "Join options";
app.add_flag_function("-nj", [&options](size_t) { options.bionj = false; },
"regular (unweighted) neighbor-joining (default)")->
group(join);
app.add_flag_function("-bionj", [&options](size_t) { options.bionj = true; },
"weighted joins as in BIONJ VeryFastTree will also weight joins during NNIs")->
group(join);
auto constrains = "Constrained topology search options";
app.add_option("-constraints", options.constraintsFile,
"an alignment with values of 0, 1, and Not all sequences need be present. A column of 0s and 1s"
" defines a constrained split. Some constraints may be violated (see 'violating constraints:' in"
" standard error).")->type_name("alignmentfile")->check(isNotEmpty)->group(constrains);
app.add_option("-constraintWeight", options.constraintWeight,
"how strongly to weight the constraints. A value of 1 means a penalty of 1 in tree length for"
" violating a constraint Default: 100.0")->type_name("w")->check(Min(0.0, false))->
group(constrains);
auto optimizations = "Optimizations";
app.add_option("-threads", options.threads,
"number of threads (n) used in the parallel execution. If this option is not set, the "
"corresponding value will be obtained from the environment variable OMP_NUM_THREADS. "
"This is the same approach followed by FastTree-2. If n=1, VeryFastTree behaves in the same way "
"than FastTree-2 compiled without the -DOPENMP flag")->
type_name("n")->check(Min(1))->envname("OMP_NUM_THREADS")->group(optimizations);
app.add_option("-threads-level", options.threadsLevel,
"degree of parallelization. If level is 0, VeryFastTree uses the same parallelization strategy as "
"FastTree-2 with some new parallel blocks. If level is 1, VeryFastTree uses parallel blocks that "
"require additional memory for computation. If level is 2, VeryFastTree accelerates the"
" rounds of ML NNIs using its tree partitioning method. If level is 3 (default), VeryFastTree "
"performs more computations without preserving sequential order. If level is 4, VeryFastTree "
"accelerates the rounds of SPR steps using its tree partitioning method (it can only be used with "
"datasets larger than 2^(sprlength + 2)). Note: Each level includes the previous ones, and computation at "
"level 2 and above is performed in a different tree traverse order, so the result may change but is "
"still correct")->
type_name("lvl")->check(CLI::Range(0, 4))->group(optimizations);
app.add_option("-threads-mode", options.deterministic,
"changes the mode of parallelization. If mode is 0, VeryFastTree uses non-deterministic parts, some"
" inspired by FastTree-2 but improved. If mode is 1 (default), VeryFastTree only uses deterministic"
" parallelization. Since version 4.0, deterministic algorithms are at least faster than "
"non-deterministic ones, making deterministic the preferred choice")->
type_name("mode")->check(CLI::Range(0, 1))->group(optimizations);
app.add_option("-threads-ptw", options.particioningTendencyWindow,
"(Partitioning Tendency Window) It sets the size of the partitioning tendency window used by the "
"tree partitioning algorithm to determine when to stop searching. The window stores the last "
"solutions and checks if a better solution can be found. Increasing the value allows the algorithm "
"to explore the tree deeper and potentially find better solutions. The default value is 50.")->
type_name("n")
->check(Min(10))->group(optimizations);
app.add_flag("-threads-verbose", options.threadsVerbose,
"to show subtrees assigned to the threads and theoretical speedup, only with verbose > 0")->
group(optimizations);
app.add_flag("-double-precision", options.doublePrecision,
"to use double precision arithmetic. "
"Therefore, it is equivalent to compile FastTree-2 with -DUSE_DOUBLE")->
group(optimizations);
app.add_set_ignore_case("-ext", options.extension, {"AUTO", "NONE", "SSE", "SSE3", "AVX", "AVX2", "AVX512", "CUDA"},
"to speed up computations enabling the vector extensions. "
"Available: AUTO(default), NONE, SSE, SSE3 , AVX, AVX2, AVX512 or CUDA")->type_name("name")
->group(optimizations)->default_val("AUTO");
app.add_option("-fastexp", options.fastexp,
"to select an alternative implementation for the exponential function exp(x), which has "
"a significant impact on performance. Options: 0 - built-in math library with double precision "
"(default), 1 - built-in math library with simple precision (not recommended with "
"-double-precision option), 2 - fast implementation to compute an approximation of "
"exp(x) using double precision, and 3 - fast implementation to compute an approximation "
"of exp(x) using simple precision (not recommended with -double-precision option)")->
type_name("lvl")->check(CLI::Range(0, 3))->group(optimizations);
app.add_flag("-disk-computing", options.diskComputing,
"if there is not enough available RAM to perform the computation, disk will be used to store extra "
"data when it was not needed. Using disk to perform the computation will substantially increase the "
"execution time")->
group(optimizations);
app.add_option("-disk-computing-path", options.diskComputingPath,
"like -disk-computing but using a custom path folder to store data")->type_name("path")->
group(optimizations);
app.add_flag("-disk-dynamic-computing", options.diskDynamicComputing,
"by default, disk computing only creates files associated with static data in RAM, which means that "
"there is no significant impact on performance as long as there is available RAM. This option further "
"reduces memory usage by storing dynamic data on disk. However, even if there is enough RAM, it will "
"have a negative impact on performance due to the constant creation and deletion of files")->
group(optimizations);
app.add_option("-disk-dynamic-limit", options.diskComputingLimit,
"-disk-dynamic-computing can exceed the limit of memory-mapped file system. If 'memory mapping "
"fails' errors occur, setting a limit will solve the problem. In Linux, the limit can be checked "
"with 'sysctl vm.max_map_count'. It is important not to use the exact value and leave a small "
"margin for other operations that require this feature")->type_name("n")->check(Min(1))->
group(optimizations);
app.add_flag("-relative-progress", options.relativeProgress,
"to shows relative time to previous step rather than absolute time in progress report")->
group(optimizations);
auto deprecated = "Deprecated";
setDeprecated(app.add_flag("-logdist", "use logarithmic distances, now on by default and obsolete")->
group(deprecated));
setDeprecated(app.add_flag("-exactml", "Exact posterior distributions, now on by default and obsolete")->
group(deprecated));
setDeprecated(app.add_flag("-mlexact", "Exact posterior distributions, now on by default and obsolete")->
group(deprecated));
app.footer("For more information, see http://www.microbesonline.org/fasttree/, "
"https://github.com/citiususc/veryfasttree or the comments in the source code");
app.add_flag("-expert", options.expert)->group("");
}
void basicCli(CLI::App &app, std::string &name, std::string &version, std::string &flags) {
for (auto *op: app.get_options()) {
((CLI::Option *) op)->group("");
}
app.name(name);
std::stringstream description;
description << name << " " << version << " " << flags << std::endl;
description << " " << name << " protein_alignment > tree" << std::endl;
description << " " << name << " < protein_alignment > tree" << std::endl;
description << " " << name << " -out tree protein_alignment" << std::endl;
description << " " << name << " -nt nucleotide_alignment > tree" << std::endl;
description << " " << name << " -nt -gtr < nucleotide_alignment > tree" << std::endl;
description << " " << name << " < nucleotide_alignment > tree" << std::endl;
description << " " << name << " accepts alignments in NEXUS, Fasta, Fastq or Phylip interleaved formats"
" compressed with ZLib and libBZ2." << std::endl;
app.description(description.str());
auto common = "Common options";
app.get_option("-n")->description("to analyze multiple alignments (phylip format only) (use for global"
" bootstrap, with seqboot and CompareToBootstrap.pl)")->group(common);
app.get_option("-intree")->description("to set the starting tree(s)")->group(common);
app.get_option("-intree1")->description("to use this starting tree for all the alignments "
"(for faster global bootstrap on huge alignments)")->group(common);
app.get_option("-quiet")->description("to suppress reporting information")->group(common);
app.get_option("-nopr")->description("to suppress progress indicator")->group(common);
app.get_option("-log")->description("save intermediate trees, settings, and model details")->group(common);
app.get_option("-quote")->description(
"allow spaces and other restricted characters (but not ' ) in sequence names and quote names in the output "
"tree (fasta/fastq input only; VeryFastTree will not be able to read these trees back in)")->group(common);
app.get_option("-pseudo")->description("to use pseudocounts (recommended for highly gapped sequences)")->
group(common);
app.get_option("-fastest")->description(
"speed up the neighbor joining phase & reduce memory usage (recommended for >50,000 sequences)")->
group(common);
app.get_option("-nosupport")->description("to not compute support values")->group(common);
app.get_option("-gtr")->description("generalized time-reversible model (nucleotide alignments only)")->
group(common);
app.get_option("-lg")->description("Le-Gascuel 2008 model (amino acid alignments only)")->group(common);
app.get_option("-wag")->description("Whelan-And-Goldman 2001 model (amino acid alignments only)")->group(common);
app.get_option("-noml")->description("to turn off maximum-likelihood")->group(common);
app.get_option("-nome")->description(
"to turn off minimum-evolution NNIs and SPRs (recommended if running additional ML NNIs with -intree),"
" -nome -mllen with -intree to optimize branch lengths for a fixed topology")->
group(common);
app.get_option("-cat")->description("to specify the number of rate categories of sites (default 20)"
" or -nocat to use constant rates")->
type_name("n")->group(common);
app.get_option("-gamma")->description("after optimizing the tree under the CAT approximation, rescale the lengths"
" to optimize the Gamma20 likelihood")->group(common);
app.get_option("-constraints")->description(
"to constrain the topology search constraintAlignment should have 1s or 0s to indicates splits")->
type_name("constraintAlignment")->group(common);
app.get_option("-threads")->description("number of threads (n) used in the parallel execution.")->
group(common);
app.get_option("-double-precision")->group(common);
app.get_option("-ext")->group(common);
app.get_option("-expert")->description("see more options")->group(common);
}
int main(int argc, char *argv[]) {
veryfasttree::Options options;
std::string name = veryfasttree::Constants::name;
std::string version = veryfasttree::Constants::version;
std::string flags = veryfasttree::Constants::compileFlags;
std::vector<std::string> args(argv + 1, argv + argc);
CLI::App app;
cli(app, name, version, flags, options, args);
basicCli(app, name, version, flags);
if (veryfasttree::isattyIn() && argc == 1) {
std::cout << app.help() << std::endl;
if (veryfasttree::isWindows()) {
std::cerr << "Windows users: Please remember to run this inside a command shell" << std::endl;
std::cerr << "Hit return to continue" << std::endl;
std::cin.ignore(1);
}
return EXIT_SUCCESS;
}
CLI11_PARSE(app, argc, argv);
if (options.expert) {
CLI::App app2;
cli(app2, name, version, flags, options, args);
CLI11_PARSE(app2, "-h", false);
}
std::ifstream finput;
std::ofstream foutput;
std::ofstream log;
veryfasttree::TeeStream tee(log, std::cerr);
std::ostream teelog(&tee);
if (options.inFileName.empty()) {
finput.setstate(std::ios_base::badbit);
} else {
finput.open(options.inFileName);
if (finput.fail()) {
std::cerr << "Couldn't open the input file! " << options.inFileName << std::endl;
return EXIT_FAILURE;
}
}
if (options.outFileName.empty()) {
foutput.setstate(std::ios_base::badbit);
} else {
foutput.open(options.outFileName);
if (foutput.fail()) {
std::cerr << "Couldn't open the output file! " << options.outFileName << std::endl;
return EXIT_FAILURE;
}
}
if (options.logFileName.empty()) {
log.setstate(std::ios_base::badbit);
} else {
log.open(options.logFileName, std::ios::out | std::ios::trunc);
if (log.fail()) {
std::cerr << "Couldn't open the log file! " << options.logFileName << std::endl;
return EXIT_FAILURE;
}
}
veryfasttree::VeryFastTree fastTree(options);
std::ostream &applog = log ? teelog : std::cerr;
applog << "Command: ";
std::copy(argv, argv + argc - 1, std::ostream_iterator<char *>(applog, " "));
applog << argv[argc - 1] << std::endl;
bxz::istream input(finput ? finput : std::cin);
std::ostream &output = foutput ? foutput : std::cout;
try {
fastTree.run(input, output, applog);
} catch (std::invalid_argument &ex) {
std::cerr << ex.what() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
|