Skip to contents

Simulate includes

Source: R/fct_simulate_includes.R
simulate_includes.Rd

This function simulates Include objects.

Usage

simulate_includes(dataset, n)

Arguments

dataset

Dataset object.

n

integer number of objects to simulate.

Value

A list of simulated Include objects.

See also

new_include.

Examples

# find data file paths
f1 <- system.file(
  "extdata", "projects", "sim_raster", "sim_raster_spatial.tif",
  package = "wheretowork"
)
f2 <- system.file(
  "extdata",  "projects", "sim_raster", "sim_raster_attribute.csv.gz",
  package = "wheretowork"
)
f3 <- system.file(
  "extdata",  "projects", "sim_raster", "sim_raster_boundary.csv.gz",
  package = "wheretowork"
)

# create new dataset
d <- new_dataset(f1, f2, f3)

# simulate data
x <- simulate_includes(dataset = d, n = 2)
# print results
print(x)
#> [[1]]
#> Include
#>   id:       af2073c6-eb59-4818-8b8d-c523d084766d
#>   name:     OECM areas
#>   variable: .../sim_raster_spatial.tif#OECM_areas [total: 168 ]
#>   pane:  bc419e92-f9f5-4234-b1a3-43de6a8fc51a-OECM_areas
#>   visible:  TRUE
#>   invisible:  NA
#>   loaded:  TRUE
#>   hidden:  FALSE
#>   downloadable:  TRUE
#>   status:   TRUE
#>   overlap:   NA
#> 
#> [[2]]
#> Include
#>   id:       40f2b43a-65fd-4fce-b656-fd47dfb5613c
#>   name:     Special Protection Area
#>   variable: .../sim_raster_spatial.tif#Special_Protection_Area [total: 156 ]
#>   pane:  5d724127-0ccc-4c88-9df5-6e407e703169-Special_Protection_Area
#>   visible:  TRUE
#>   invisible:  NA
#>   loaded:  TRUE
#>   hidden:  FALSE
#>   downloadable:  TRUE
#>   status:   TRUE
#>   overlap:   NA
#>