TreeDriftingOptions: Set options for tree drifting
In paravian/nitro: Integration of TNT in R
TreeDriftingOptions R Documentation
Set options for tree drifting
Description
TreeDriftingOptions is an R6 class that defines the set of parameters
required for performing tree drift operations in nitro.
Active bindings
iterationsAn integer value indicating the number of tree-drifting
cycles to perform.
substitutionsAn integer value indicating the number of replacements
(i.e., accepted tree rearrangements) to perform in the perturbation phase.
max_abs_fit_diffA numeric value indicating the maximum absolute fit
difference.
max_rel_fit_diffA numeric value indicating the maximum relative fit
difference.
reject_factorA numeric value indicating the rejection factor for
suboptimal trees.
autoconstrain_cyclesAn integer value indicating the number of
autoconstrained cycles to perform.
Methods
Public methods
-
-
-
-
Method new()
Usage
TreeDriftingOptions$new(
iterations = 30,
substitutions = 60,
max_abs_fit_diff = 1,
max_rel_fit_diff = 0.2,
reject_factor = 3,
autoconstrain_cycles = 0
)
Arguments
iterationsAn integer value indicating the number of tree-drifting
cycles to perform.
substitutionsAn integer value indicating the number of replacements
(i.e., accepted tree rearrangements) to perform in the perturbation phase.
max_abs_fit_diffA numeric value indicating the maximum absolute fit
difference.
max_rel_fit_diffA numeric value indicating the maximum relative fit
difference.
reject_factorA numeric value indicating the rejection factor for
suboptimal trees.
autoconstrain_cyclesAn integer value indicating the number of
autoconstrained cycles to perform.
Method print()
Usage
TreeDriftingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
TreeDriftingOptions$queue(set_only = FALSE)
Arguments
set_onlyA logical indicating whether to instruct the command to
execute immediately (TRUE) or set the variables for future
execution FALSE.
Method clone()
The objects of this class are cloneable with this method.
Usage
TreeDriftingOptions$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
paravian/nitro documentation built on Jan. 17, 2025, 11:21 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| TreeDriftingOptions | R Documentation |
Set options for tree drifting
Description
TreeDriftingOptions is an R6 class that defines the set of parameters
required for performing tree drift operations in nitro.
Active bindings
iterationsAn integer value indicating the number of tree-drifting cycles to perform.
substitutionsAn integer value indicating the number of replacements (i.e., accepted tree rearrangements) to perform in the perturbation phase.
max_abs_fit_diffA numeric value indicating the maximum absolute fit difference.
max_rel_fit_diffA numeric value indicating the maximum relative fit difference.
reject_factorA numeric value indicating the rejection factor for suboptimal trees.
autoconstrain_cyclesAn integer value indicating the number of autoconstrained cycles to perform.
Methods
Public methods
Method new()
Usage
TreeDriftingOptions$new( iterations = 30, substitutions = 60, max_abs_fit_diff = 1, max_rel_fit_diff = 0.2, reject_factor = 3, autoconstrain_cycles = 0 )
Arguments
iterationsAn integer value indicating the number of tree-drifting cycles to perform.
substitutionsAn integer value indicating the number of replacements (i.e., accepted tree rearrangements) to perform in the perturbation phase.
max_abs_fit_diffA numeric value indicating the maximum absolute fit difference.
max_rel_fit_diffA numeric value indicating the maximum relative fit difference.
reject_factorA numeric value indicating the rejection factor for suboptimal trees.
autoconstrain_cyclesAn integer value indicating the number of autoconstrained cycles to perform.
Method print()
Usage
TreeDriftingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
TreeDriftingOptions$queue(set_only = FALSE)
Arguments
set_onlyA logical indicating whether to instruct the command to execute immediately (
TRUE) or set the variables for future executionFALSE.
Method clone()
The objects of this class are cloneable with this method.
Usage
TreeDriftingOptions$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.