data_modify_pops: Modify Populations within IFC_data Object

View source: R/data_modify_pops.R

data_modify_popsR Documentation

Modify Populations within IFC_data Object

Description

Modify populations in an already existing 'IFC_data' object.

Usage

data_modify_pops(obj, pops, display_progress = TRUE, ...)

Arguments

obj

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

pops

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

display_progress

whether to display a progress bar. Default is TRUE.

...

Other arguments to be passed.

Details

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

Value

an IFC_data object with pops modified.


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