check_input_args: Sanity checks for arguments passed to predict_delta_comps()

View source: R/check_input_args.R

check_input_argsR Documentation

Sanity checks for arguments passed to predict_delta_comps()

Description

Sanity checks for arguments passed to predict_delta_comps()

Usage

check_input_args(dataf, y, comps, covars, deltas)

Arguments

dataf

A data.frame containing data

y

Name (as string/character vector of length 1) of outcome variable in dataf

comps

Character vector of names of compositions in dataf. See details for more information.

covars

Character vector of covariates names (non-comp variables) in dataf or NULL for none (default).

deltas

A vector of time-component changes (as proportions of compositions , i.e., values between -1 and 1). Optional.

Details

Throws errors for any problematic input. Returns TRUE invisibly if no issues found.


tystan/deltacomp documentation built on Oct. 26, 2022, 7:24 a.m.