apci.plot: Visualization for data exploration or model results

View source: R/visualization.R

apci.plotR Documentation

Visualization for data exploration or model results

Description

Visualize the outcome or APC-I model results in a simple plot.

Usage

apci.plot(model, age, period, outcome_var,
type = "model", quantile = NULL, ...)

Arguments

model

A list, inheriting the corresponding results generated by function apci.

outcome_var

An object of class character representing the name of the outcome variable used in APC-I model. The outcome variable itself can be numerical and categorical.

age

An object of class character representing the age group index taking on a small number of distinct values in the data. Usually, the vector should be converted to a factor (or the terms of "category" and "enumerated type").

period

An object of class character, similar to the argument of age, representing the time period index in the data.

type

Character, "explore" or "model". If type is "explore", plots for age and period raw scores will be generated. If type is "model", model results will be plotted. The default setting is "model".

quantile

A number between 0 and 1, representing the percentiles to be used in visualizing the data or model. If NULL, the original magnitude will be used.

...

Jiahui1902/APCI documentation built on Sept. 6, 2024, 3:40 a.m.