initialize-incClass-method: Constructor incClass

Description Usage Arguments

Description

Constructor for new analysis object

Usage

1
2
3
4
5
## S4 method for signature 'incClass'
initialize(.Object, dateCreated = base::POSIXct,
  population = data.frame, cases = data.frame, nPred = numeric,
  nFit = numeric, predLast = numeric, gridFactor = numeric,
  entity = character, ...)

Arguments

.Object

class instance

dateCreated

Date of creation

population

data.frame containing count data with years in rows (first row: earliest year) and numeric ages in cols (increasing from left to right)

cases

data.frame containing count data, same design as the population data

nPred

Prediction period. Calculated backwards from the earliest valid (in population and incidence available) year.

nFit

Model fitting period. Counted backwards from the earliest year from which the prediction period starts. For forward projection of last observation, the year previous to the start of the prediction interval is selected.

predLast

Return only last observation year predictions and metrics when using the metrics() function.

gridFactor

Ratio of age-width and yearly structure. If data is given in yearly fashion and 1-year age groups, the grid factor is 1. For yearly data and 5-year age groups, the grid factor is 5.

entity

Free text variable.

...

additional parameters


mknoll/incAnalysis documentation built on Oct. 22, 2020, 9:20 a.m.