extract_ccmpp_input_list_attributes: Extract attributes of a 'ccmpp_input_list'

In markalava/ccmppWPP: Cohort Component Population Projection

Extract attributes of a ccmpp_input_list

Description

These are convenience functions for accessing specific attributes and dimensions of objects inheriting from ccmpp_input_list.

Usage

## S3 method for class 'list'
age_span(x)

## S3 method for class 'ccmpp_input_list'
age_span(x)

## S3 method for class 'list'
time_span(x)

## S3 method for class 'ccmpp_input_list'
time_span(x)

## S3 method for class 'list'
ages(x)

## S3 method for class 'ccmpp_input_list'
ages(x)

## S3 method for class 'list'
non_zero_fert_ages(x)

## S3 method for class 'ccmpp_input_list'
non_zero_fert_ages(x)

## S3 replacement method for class 'ccmpp_input_list'
non_zero_fert_ages(x) <- value

## S3 method for class 'list'
times(x)

## S3 method for class 'ccmpp_input_list'
times(x)

proj_times(x)

## S3 method for class 'list'
proj_times(x)

## S3 method for class 'list'
proj_times(x)

## S3 method for class 'list'
sexes(x)

## S3 method for class 'ccmpp_input_list'
sexes(x)

## S3 method for class 'list'
indicators(x, drop = TRUE)

## S3 method for class 'ccmpp_input_list'
indicators(x, drop = TRUE)

## S3 method for class 'list'
value_type(x)

## S3 method for class 'ccmpp_input_list'
value_type(x)

## S3 method for class 'list'
value_scale(x)

## S3 method for class 'ccmpp_input_list'
value_scale(x)

Arguments

x	An object inheriting from ccmpp_input_list, or a list that can be coerced to a ccmpp_input_list via as_ccmpp_input_list.
drop	Logical, for indicators: should NULL elements be dropped?

Details

age_span and time_span return the attribute, which are scalars. ages, times, sexes return the levels of these dimensions (see also ages.demog_change_component_df). indicators and value_type return lists, with one element per element of x. By default, elements that do not have an “indicator” dimension are dropped by indicators.

Value

The requested attribute or dimension levels; see “Details”.

Author(s)

Mark Wheldon

See Also

Other extract_attributes: non_zero_fert_ages(), value_scale()

markalava/ccmppWPP documentation built on April 21, 2022, 12:36 a.m.