Get ppopulation strain information

Source: R/universe_utils.R

Get ppopulation strain information

pop_strains_df(
  statePtr,
  seed,
  sample_size = 0,
  sample_states = 0:5,
  ibd = FALSE
)

Arguments

statePtr

Universe state pointer

seed

The random seed. Probably not needed but was here for debugging radnomness.

sample_size

Number of indiviudals to sample. Default = 0, which samples everyone.

sample_states

Numeric vector for which sample states are to be sampled from Default = 0:5, which is all states.

ibd

Boolean for whether the siulation is an IBD one.

Details

R side wrapper for c++ functions that loop through the population retrieving information about their strains using the universe state ptr. The resulting data frame is then passed to COI_df_create.