new_mig_parameter: Low-level constructor for class 'mig_parameter'.

View source: R/S3_classes_ccmpp_input_mig_parameter_df.R

new_mig_parameterR Documentation

Low-level constructor for class mig_parameter.

Description

Creates an object of class mig_parameter. Minimal checks are done; for interactive use see mig_parameter.

This function is not exported. The user-level constructor is mig_parameter.

Usage

new_mig_parameter(
  x,
  time_span = double(),
  dimensions = get_req_dimensions_for_subclass_classes("mig_parameter"),
  value_type = get_value_types_for_subclass_classes("mig_parameter"),
  value_scale = NA,
  ...,
  class = character()
)

Arguments

dimensions

Character vector listing the dimensions such as “time”, “age”, “sex”.

value_type

Scalar indicating the type of the “value” column (e.g., “count”, “rate”, etc.).

value_scale

Numeric scalar indicating the value_scale of the counts, e.g., 1, 1000, 1e6, etc.

Value

An object of class mig_parameter.

Author(s)

Mark Wheldon

See Also

mig_parameter


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