Learn R Programming

epiparameter (version 0.4.1)

is_parameterised: Check if <epiparameter> or list of <epiparameter> objects contains a distribution and distribution parameters

Description

Check if <epiparameter> or list of <epiparameter> objects contains a distribution and distribution parameters

Usage

is_parameterised(x, ...)

is_parameterized(x, ...)

# S3 method for epiparameter is_parameterised(x, ...)

# S3 method for multi_epiparameter is_parameterised(x, ...)

Value

A single boolean logical for <epiparameter> or vector of logicals equal in length to the list of <epiparameter> objects input. If the <epiparameter> object is missing either a probability distribution or parameters for the probability distribution returns FALSE, otherwise it returns TRUE.

Arguments

x

An <epiparameter> or list of <epiparameter> objects.

...

dots Extra arguments to be passed to the method.

Examples

Run this code
# parameterised 
ep <- epiparameter(
  disease = "ebola",
  epi_name = "incubation",
  prob_distribution = create_prob_distribution(
    prob_distribution = "gamma",
    prob_distribution_params = c(shape = 1, scale = 1)
  )
)
is_parameterised(ep)

# unparameterised 
ep <- epiparameter(
  disease = "ebola",
  epi_name = "incubation"
)
is_parameterised(ep)

# list of 
db <- epiparameter_db()
is_parameterised(db)

Run the code above in your browser using DataLab