CMAPLE 1
CMaple phylogenetic software
Loading...
Searching...
No Matches
Public Attributes | List of all members
cmaple::Params Class Reference

#include <tools.h>

Public Attributes

std::string aln_path
 
std::string ref_path
 
std::string ref_seqname
 
std::string aln_format_str
 
std::string sub_model_str
 
bool overwrite_output
 
bool fixed_blengths
 
RealNumType threshold_prob
 
RealNumType threshold_prob2
 
int failure_limit_sample
 
int failure_limit_subtree
 
int failure_limit_subtree_short_search
 
bool strict_stop_seeking_placement_sample
 
bool strict_stop_seeking_placement_subtree
 
bool strict_stop_seeking_placement_subtree_short_search
 
RealNumType thresh_log_lh_sample
 
RealNumType thresh_log_lh_subtree
 
RealNumType thresh_log_lh_subtree_short_search
 
RealNumType thresh_log_lh_failure
 
RealNumType fixed_min_blength
 
RealNumType min_blength_factor
 
RealNumType max_blength_factor
 
RealNumType min_blength_mid_factor
 
RealNumType thresh_diff_update
 
RealNumType thresh_diff_fold_update
 
PositionType mutation_update_period
 
std::string output_aln
 
std::string output_aln_format_str
 
std::string input_treefile
 
int32_t num_tree_improvement
 
RealNumType thresh_placement_cost
 
RealNumType thresh_entire_tree_improvement
 
RealNumType thresh_placement_cost_short_search
 
std::string tree_format_str
 
bool shallow_tree_search
 
char * output_testing
 
bool compute_aLRT_SH
 
PositionType aLRT_SH_replicates
 
RealNumType aLRT_SH_half_epsilon
 
uint32_t num_threads
 
uint64_t ran_seed
 
std::string output_prefix
 
bool allow_replace_input_tree
 
std::string seq_type_str
 
std::string tree_search_type_str
 
bool make_consistent
 

Detailed Description

Program parameters, everything is specified here

Member Data Documentation

◆ aln_path

std::string cmaple::Params::aln_path

Path to input sequences

◆ ref_path

std::string cmaple::Params::ref_path

Name of an alignment that contains the reference sequence

◆ ref_seqname

std::string cmaple::Params::ref_seqname

Name of the reference sequence

◆ aln_format_str

std::string cmaple::Params::aln_format_str

Alignment format

◆ sub_model_str

std::string cmaple::Params::sub_model_str

Substitution model (e.g., HKY, GTR, JC, etc.)

◆ overwrite_output

bool cmaple::Params::overwrite_output

TRUE to override the output files

◆ fixed_blengths

bool cmaple::Params::fixed_blengths

TRUE to fixed the branch lengths in the input tree

◆ threshold_prob

RealNumType cmaple::Params::threshold_prob

A relative probability threshold, which is used to ignore possible states with very low probabilities. Default: 1e-8

◆ threshold_prob2

RealNumType cmaple::Params::threshold_prob2

threshold_prob ^ 2

◆ failure_limit_sample

int cmaple::Params::failure_limit_sample

The number to limit the attempts of seeking a placement for a sample

◆ failure_limit_subtree

int cmaple::Params::failure_limit_subtree

The number to limit the attempts of seeking a placement for a subtree

◆ failure_limit_subtree_short_search

int cmaple::Params::failure_limit_subtree_short_search

The number to limit the attempts of seeking a placement for a subtree (short range search)

◆ strict_stop_seeking_placement_sample

bool cmaple::Params::strict_stop_seeking_placement_sample
    TRUE to apply strict stop rules when seeking placement for a new

sample

◆ strict_stop_seeking_placement_subtree

bool cmaple::Params::strict_stop_seeking_placement_subtree

TRUE to apply strict stop rules when seeking placement for a subtree

◆ strict_stop_seeking_placement_subtree_short_search

bool cmaple::Params::strict_stop_seeking_placement_subtree_short_search
    TRUE to apply strict stop rules when seeking placement for a subtree

(short range search)

◆ thresh_log_lh_sample

RealNumType cmaple::Params::thresh_log_lh_sample

Threshold of loglh to continue explore the subtree to seek a placement for a sample

◆ thresh_log_lh_subtree

RealNumType cmaple::Params::thresh_log_lh_subtree

Threshold of loglh to continue explore the subtree to seek a placement for a subtree

◆ thresh_log_lh_subtree_short_search

RealNumType cmaple::Params::thresh_log_lh_subtree_short_search

Threshold of loglh to continue explore the subtree to seek a placement for a subtree (short range search)

◆ thresh_log_lh_failure

RealNumType cmaple::Params::thresh_log_lh_failure

Threshold of loglh to count failure

◆ fixed_min_blength

RealNumType cmaple::Params::fixed_min_blength

A minimum value of the branch lengths. Default: -1 (UNSPECIFIED), the minimum branch length is computed from 'min_blength_factor'

◆ min_blength_factor

RealNumType cmaple::Params::min_blength_factor

A factor to compute the minimum branch length (if fixed_min_blength is specified, this factor is ignored). Default: 0.2
<Minimum branch length> = <min_blength_factor> * <default branch length>
where <default branch length> is one mutation per site.

◆ max_blength_factor

RealNumType cmaple::Params::max_blength_factor

A factor to compute the maximum branch length. Default: 40
<Maximum branch length> = <max_blength_factor> * <default branch length>
where <default branch length> is one mutation per site.

◆ min_blength_mid_factor

RealNumType cmaple::Params::min_blength_mid_factor

The minium branch length (for mid-branch point) to try for placement

◆ thresh_diff_update

RealNumType cmaple::Params::thresh_diff_update

Threshold to determine whether a changed partial is different from its former value

◆ thresh_diff_fold_update

RealNumType cmaple::Params::thresh_diff_fold_update

Threshold to determine whether a changed partial is different from its former value by folds

◆ mutation_update_period

PositionType cmaple::Params::mutation_update_period

The period (in term of the number of sample placements) to update the substitution rate matrix. Default: 25

◆ output_aln

std::string cmaple::Params::output_aln

Name of the output alignment

◆ output_aln_format_str

std::string cmaple::Params::output_aln_format_str

Format of the output alignment

◆ input_treefile

std::string cmaple::Params::input_treefile

Path to an input tree

◆ num_tree_improvement

int32_t cmaple::Params::num_tree_improvement

The number of times we traverse the tree looking for topological improvements (applying SPR moves). Default: 1

◆ thresh_placement_cost

RealNumType cmaple::Params::thresh_placement_cost

Do not try to apply SPR moves on nodes that have the placement cost (i.e. the likelihood contribution by placing a node on the tree) exceeds this threshold. Default: -1e-5

◆ thresh_entire_tree_improvement

RealNumType cmaple::Params::thresh_entire_tree_improvement

Threshold to stop the tree search. If the total log likelihood improvement obtained by an iteration of tree search is lower than this threshold, CMaple stops doing tree search . Default: 1

◆ thresh_placement_cost_short_search

RealNumType cmaple::Params::thresh_placement_cost_short_search

Don't try to re-place nodes (during short range topology search) that have the placement cost exceeds this threshold

◆ tree_format_str

std::string cmaple::Params::tree_format_str

format of the output tree

◆ shallow_tree_search

bool cmaple::Params::shallow_tree_search

TRUE to run an additional short range search for tree topology improvement

◆ output_testing

char* cmaple::Params::output_testing

path to output testing codes

◆ compute_aLRT_SH

bool cmaple::Params::compute_aLRT_SH

TRUE to compute aLRT-SH

◆ aLRT_SH_replicates

PositionType cmaple::Params::aLRT_SH_replicates

Number of replicates to compute aLRT-SH

◆ aLRT_SH_half_epsilon

RealNumType cmaple::Params::aLRT_SH_half_epsilon

(Half) epsilon value when computing aLRT-SH

◆ num_threads

uint32_t cmaple::Params::num_threads

number of threads

◆ ran_seed

uint64_t cmaple::Params::ran_seed

A seed number for random generators. Default: the clock of the PC. Be careful! To make the results reproducible, users should specify the seed number.

◆ output_prefix

std::string cmaple::Params::output_prefix

prefix output

◆ allow_replace_input_tree

bool cmaple::Params::allow_replace_input_tree

TRUE to allow replace the input tree by its NNI neighbor (with a higher lh) when computing aLRT-SH

◆ seq_type_str

std::string cmaple::Params::seq_type_str

type of sequences

◆ tree_search_type_str

std::string cmaple::Params::tree_search_type_str

type of tree search

◆ make_consistent

bool cmaple::Params::make_consistent

TRUE to make the processes of outputting->re-inputting a tree consistent


The documentation for this class was generated from the following file: