is_applicable_to_covset: Check equation for covariates

In UBESP-DCTV/equationer: Equations of Energy Requirements

Description

Check if any of the given equation(s) can be applied to the supplied set of covariates

Usage

is_applicable_to_covset(x, cov)

## S3 method for class 'eq'
is_applicable_to_covset(x, cov)

## S3 method for class 'eqs'
is_applicable_to_covset(x, cov)

Arguments

x	equation(s set/bag) object
cov	(chr) vector of covariates

Value

(lgl) TRUE if the covariates supplied are a subset of the covariates needed to solve at least one of the equations in x.

Methods (by class)

• eq: Check if the equation can be applied to the covariates supplied.

• eqs: Check if (all) the equations in the eqs object can be applied to the covariates supplied.

Examples

library(equationer)
eq_test <- eq(age = 0.1, bmi = -0.3,
    name    = "first eq_test",
    outcome = "kcal/day"
)
is_applicable_to_covset(eq_test, c("age", "bmi")) # TRUE
is_applicable_to_covset(eq_test, c("age", "bmi", "sex")) # TRUE
is_applicable_to_covset(eq_test, c("age")) # FALSE
is_applicable_to_covset(eq_test, c("age", "sex")) # FALSE
library(equationer)
eq_test <- eq(age = 0.1, bmi = -0.3,
    name    = "eq_test",
    outcome = "kcal/day",
    strata = list(sex = "female")
)
eq2_test <- eq(age = 0.1, bmi = -0.3,
    name    = "eq2_test",
    outcome = "kcal/day",
    strata = list(sex = "male")
)

eqs_test <- eqs(eq_test, eq2_test, name = "eqs-test")

is_applicable_to_covset(eqs_test, c("age", "bmi")) # TRUE
is_applicable_to_covset(eqs_test, c("age", "bmi", "sex")) # TRUE
is_applicable_to_covset(eqs_test, c("age")) # FALSE
is_applicable_to_covset(eqs_test, c("age", "sex")) # FALSE

UBESP-DCTV/equationer documentation built on Jan. 17, 2021, 6:30 p.m.