TreeHybridizingOptions: Set options for tree hybridizing
In paravian/nitro: Integration of TNT in R
TreeHybridizingOptions R Documentation
Set options for tree hybridizing
Description
TreeHybridizingOptions is an R6 class that defines the set of
parameters required for performing tree hybridizing operations in
nitro.
Active bindings
roundsAn integer value indicating the number of rounds of
tree-hybridizing to perform.
hybridizationsAn integer value indicating the number of
hybridizations to perform in each round.
best_treesAn integer value indicating the number of best trees from
the previous round of hybridizing to use in the next round.
replaceA logical value indicating whether to replace the source tree
with a better tree produced by hybridizing.
sample_factorAn integer value indicating the number of times to
increase the size of initial tree set by. The corresponding number of trees
to retain will be proportional to the inverse of this value.
Methods
Public methods
-
-
-
-
Method new()
Usage
TreeHybridizingOptions$new(
rounds = 1,
hybridizations = 1000,
best_trees = 50,
replace = TRUE,
sample_factor = 15
)
Arguments
roundsAn integer value indicating the number of rounds of
tree-hybridizing to perform.
hybridizationsAn integer value indicating the number of
hybridizations to perform in each round.
best_treesAn integer value indicating the number of best trees from
the previous round of hybridizing to use in the next round.
replaceA logical value indicating whether to replace the source tree
with a better tree produced by hybridizing.
sample_factorAn integer value indicating the number of times to
increase the size of initial tree set by. The corresponding number of trees
to retain will be proportional to the inverse of this value.
Method print()
Usage
TreeHybridizingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
TreeHybridizingOptions$queue(...)
Arguments
...Ignored.
Method clone()
The objects of this class are cloneable with this method.
Usage
TreeHybridizingOptions$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.
| TreeHybridizingOptions | R Documentation |
Set options for tree hybridizing
Description
TreeHybridizingOptions is an R6 class that defines the set of
parameters required for performing tree hybridizing operations in
nitro.
Active bindings
roundsAn integer value indicating the number of rounds of tree-hybridizing to perform.
hybridizationsAn integer value indicating the number of hybridizations to perform in each round.
best_treesAn integer value indicating the number of best trees from the previous round of hybridizing to use in the next round.
replaceA logical value indicating whether to replace the source tree with a better tree produced by hybridizing.
sample_factorAn integer value indicating the number of times to increase the size of initial tree set by. The corresponding number of trees to retain will be proportional to the inverse of this value.
Methods
Public methods
Method new()
Usage
TreeHybridizingOptions$new( rounds = 1, hybridizations = 1000, best_trees = 50, replace = TRUE, sample_factor = 15 )
Arguments
roundsAn integer value indicating the number of rounds of tree-hybridizing to perform.
hybridizationsAn integer value indicating the number of hybridizations to perform in each round.
best_treesAn integer value indicating the number of best trees from the previous round of hybridizing to use in the next round.
replaceA logical value indicating whether to replace the source tree with a better tree produced by hybridizing.
sample_factorAn integer value indicating the number of times to increase the size of initial tree set by. The corresponding number of trees to retain will be proportional to the inverse of this value.
Method print()
Usage
TreeHybridizingOptions$print(...)
Arguments
...Ignored.
Method queue()
Usage
TreeHybridizingOptions$queue(...)
Arguments
...Ignored.
Method clone()
The objects of this class are cloneable with this method.
Usage
TreeHybridizingOptions$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.