is_truncated: Check if distribution in <epiparameter> is truncated

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

Check if distribution in ⁠<epiparameter>⁠ is truncated

Description

Check if distribution in ⁠<epiparameter>⁠ is truncated

Usage

is_truncated(x)

Arguments

x	An ⁠<epiparameter>⁠ object.

Details

The ⁠<epiparameter>⁠ class can hold probability distribution objects from the {distributional} package or the {distcrete} package, however, only distribution objects from {distributional} can be truncated. If a ⁠<epiparameter>⁠ object has a ⁠<distcrete>⁠ object is_truncated will return FALSE by default.

Value

A boolean logical.

Examples

ep <- epiparameter(
  disease = "ebola",
  epi_name = "incubation_period",
  prob_distribution = create_prob_distribution(
    prob_distribution = "lnorm",
    prob_distribution_params = c(meanlog = 1, sdlog = 1)
  )
)
is_truncated(ep)

ep <- epiparameter(
  disease = "ebola",
  epi_name = "incubation_period",
  prob_distribution = create_prob_distribution(
    prob_distribution = "lnorm",
    prob_distribution_params = c(meanlog = 1, sdlog = 1),
    truncation = 10
  )
)
is_truncated(ep)

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