Skip to contents

Retrieving sample information

Source: R/RcppExports.R
SpatialSimulation-cash-get_samples_info.Rd

This method retrieves information about the samples collected along the simulation.

Value

A dataframe containing, for each sample collected during the simulation, the columns "name", "time", "ymin", "xmin", "ymax", "xmax", "tumour_cells", and "tumour_cells_in_bbox". The columns "ymin", "xmin", "ymax", "xmax" report the boundaries of the sample bounding box, while "tumour_cells" and "tumour_cells_in_bbox" are the number of tumour cells in the sample and in the bounding box, respectively.

See also

SpatialSimulation$sample_cells(), SamplesForest$get_samples_info(), PhylogeneticForest$get_samples_info()

Examples

# set the seed of the random number generator
set.seed(0)

# create a simulation
sim <- SpatialSimulation()
sim$add_mutant(name = "A",
               growth_rate = 0.2,
               death_rate = 0.01)
sim$place_cell("A", 500, 500)

sim$death_activation_level <- 100
sim$run_up_to_size(species = "A", num_of_cells = 50000)
#> 
 [████████████████████████████████████████] 100% [00m:00s] Saving snapshot                                 


# sample the region [450,500]x[475,550]
sim$sample_cells("S1", lower_corner=c(450,475), upper_corner=c(500,550))

# simulate 1 time unit more
sim$run_up_to_time(sim$get_clock()+1)
#> 
 [████████████████████████████████████████] 100% [00m:00s] Saving snapshot                                 


# sample the region [500,520]x[525,550]
sim$sample_cells("S2", lower_corner=c(500,525), upper_corner=c(520,550))

# get information about all the collected
# samples, i.e, S1 and S2
sim$get_samples_info()
#>   name xmin ymin xmax ymax tumour_cells tumour_cells_in_bbox     time
#> 1   S1  450  475  500  550         3863                 3863 215.0761
#> 2   S2  500  525  520  550          531                  531 216.0767