is_epiparameter: Check object is an <epiparameter>

In epiparameter: Classes and Helper Functions for Working with Epidemiological Parameters

Check object is an ⁠<epiparameter>⁠

Description

Check object is an ⁠<epiparameter>⁠

Usage

is_epiparameter(x)

Arguments

x	An R object.

Value

A boolean logical, TRUE if the object is an ⁠<epiparameter>⁠ and FALSE if not.

Examples

ep <- epiparameter(
  disease = "ebola",
  epi_name = "serial_interval",
  prob_distribution = create_prob_distribution(
    prob_distribution = "gamma",
    prob_distribution_params = c(shape = 1, scale = 1)
  )
)

is_epiparameter(ep)

false_ep <- list(
  disease = "ebola",
  epi_name = "serial_interval",
  prob_distribution = "gamma",
  prob_distribution_params = c(shape = 1, scale = 1)
)

is_epiparameter(false_ep)

epiparameter documentation built on April 3, 2025, 5:50 p.m.