simulate_single_pd_tree_cpp: Simulate a single phylogenetic diversity tree using C++...

View source: R/simulation_tree_pd.R View source: R/RcppExports.R

simulate_single_pd_tree_cppR Documentation

Simulate a single phylogenetic diversity tree using C++ backend

Description

This function interfaces with a C++ function to simulate a single phylogenetic tree based on the provided parameters and constraints.

Usage

simulate_single_pd_tree_cpp(pars, max_t, max_N, max_tries)

Arguments

pars

A numeric vector of parameters required by the C++ simulation function.

max_t

The maximum time or iterations to run the simulation for.

max_N

The maximum number of nodes that the phylogenetic tree should have.

max_tries

The maximum number of tries to attempt the simulation before stopping.

Value

A simulated phylogenetic tree object (specific format to be detailed).

Examples

# Example usage:
# Define parameters (example parameters to be replaced with actual ones)
parameters <- c(0.1, 0.2, 0.3)
max_time <- 10000
max_nodes <- 100
max_attempts <- 10

# Run the simulation
tree <- simulate_single_pd_tree_cpp(parameters, max_time, max_nodes, max_attempts)


franciscorichter/emphasis documentation built on Feb. 19, 2024, 7:36 p.m.