data_modify_regions: Modify Populations within IFC_data Object

View source: R/data_modify_regions.R

data_modify_regionsR Documentation

Modify Populations within IFC_data Object

Description

Modify populations in an already existing 'IFC_data' object.

Usage

data_modify_regions(obj, regions, display_progress = TRUE, ...)

Arguments

obj

an 'IFC_data' object extracted by ExtractFromDAF(extract_features = TRUE) or ExtractFromXIF(extract_features = TRUE).

regions

a list of region(s) to modify in 'obj'. Each element of this list will be coerced by buildRegion.

display_progress

whether to display a progress bar. Default is TRUE.

...

Other arguments to be passed.

Details

regions names should be present in names(obj$regions), otherwise an error will be raised.
Note that If you want to rename regions, you should do it by changing 'label' member, e.g. regions[[1]]$label <- "bar" while names(regions[[1]]) is "foo" and "foo" is part of names(obj$regions).

Value

an IFC_data object with regions modified.


IFC documentation built on Sept. 14, 2023, 1:08 a.m.