new_ccmpp_input_df: Low-level constructor for class 'ccmpp_input_df'.

View source: R/S3_classes_ccmpp_input_df.R

new_ccmpp_input_dfR Documentation

Low-level constructor for class ccmpp_input_df.

Description

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

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

Usage

new_ccmpp_input_df(
  x,
  dimensions = character(),
  age_span = double(),
  time_span = double(),
  value_type = character(),
  value_scale = numeric(),
  ...,
  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 ccmpp_input_df.

Author(s)

Mark Wheldon

See Also

ccmpp_input_df


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