initialize-dictionary-method: Initializer method for dictionary class

initialize,dictionary-methodR Documentation

Initializer method for dictionary class

Description

sets defaults but allows them to be overridden by provided values

Usage

## S4 method for signature 'dictionary'
initialize(
  .Object,
  key = NA_character_,
  context = NA_character_,
  year = NA_character_,
  components = c("identity", "behavior", "modifier"),
  stats = c("mean"),
  groups = c("male", "female", "all"),
  individual = FALSE,
  filetype = ".dat",
  source = "Interact 2.1 beta (May 2021)",
  description = "unknown",
  citation = "unknown",
  notes = "none"
)

Arguments

.Object

dictionary object (self)

key

dictionary name

context

country or context collected in

year

year collected

components

available components

stats

available summary statistics

groups

available groups

individual

whether individual data is available

filetype

original source filetype

source

where data came from

description

description provided for data

citation

citation provided for data

notes

any notes for the dataset

dictionary

dictionary object

Value

a new dictionary object


ahcombs/actdata documentation built on Jan. 15, 2025, 6:48 p.m.