New include — new_include • wheretowork

Create a new Include object.

Usage

new_include(
  name,
  variable,
  mandatory = FALSE,
  visible = TRUE,
  invisible = NA_real_,
  loaded = TRUE,
  hidden = FALSE,
  downloadable = TRUE,
  status = TRUE,
  overlap = NA_character_,
  id = uuid::UUIDgenerate(),
  pane = paste(uuid::UUIDgenerate(), variable$index, sep = "-")
)

Arguments

name: character Name to display.
variable: Variable object.
mandatory: logical value indicating if object is mandatory for generating solutions.
visible: logical The initial visible value. This is used to determine if the feature is displayed (or not) or not the map. Defaults to TRUE.
invisible: numeric date/time. A time stamp date given to when a loaded layer is first turned invisible. This is used to keep track of loaded invisible layers to offload once the cache threshold has been reached. Defaults to NA_real_.
loaded: logical The initial loaded value. This is used to determine if the feature has been loaded into the DOM. Defaults to FALSE.
hidden: logical The hidden value. This is used to determine if the feature can ever be displayed. Unlike visible, if this parameter is FALSE then a feature can never be viewed on the map. Defaults to FALSE.
downloadable: logical The downloadable value. This is used to determine if the feature can be download. Set downloadable to FALSE for sensitive layers that should not be avaiable for download. Defaults to TRUE.
status: logical The initial status value. This is used to display information on whether the feature is selected (or not) for subsequent analysis. Defaults to TRUE.
overlap: character vector that remains NA_character_ until set in the SolutionSettings object. overlap defines the include and exclude overlap.
id: character unique identifier. Defaults to a random identifier (uuid::UUIDgenerate()).
pane: character unique map pane identifier. Defaults to a random identifier (uuid::UUIDgenerate()) concatenated with layer index.

Value

A Include object.

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)

# create new variable
v <- new_variable_from_auto(d, index = 1)

# create a new include
w <- new_include(name = "Protected areas", variable = v)

# print object
print(w)
#> Include
#>   id:       b3c1d440-bc3a-42ba-b9ff-6746341eaa42
#>   name:     Protected areas
#>   variable: .../sim_raster_spatial.tif#Brown_necked_Parrot_Brown_necked_ [total: 483 ]
#>   pane:  3560ef24-4361-482a-929d-23a9fd977f60-Brown_necked_Parrot_Brown_necked_
#>   visible:  TRUE
#>   invisible:  NA
#>   loaded:  TRUE
#>   hidden:  FALSE
#>   downloadable:  TRUE
#>   status:   TRUE
#>   overlap:   NA