data_add_pop_sample: Population Sampling

View source: R/data_add_pop_sample.R

data_add_pop_sampleR Documentation

Population Sampling

Description

Creates a sample from a population

Usage

data_add_pop_sample(obj, pop, size, new_name, random_seed = NULL, ...)

Arguments

obj

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

pop

name of the population to sample.

size

a non-negative integer giving the number of items to choose.

new_name

name of the exported population.

random_seed

a list of elements to pass to set.seed or a single value, interpreted as an integer, or NULL to be used when 'add_noise' is set to TRUE. Default is NULL. Note that NA_integer_ or list(seed = NA_integer_) can be used to not call set.seed at all.

...

Other arguments to be passed.

Details

population is exported as tagged population.

Value

an IFC_data object with sampled pop added.


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