family.epiparameter | R Documentation |
<epiparameter>
classThe family()
function is used to extract the distribution
names from objects from {distributional}
and {distcrete}
. This method
provides the same interface for <epiparameter>
objects to give consistent
output irrespective of the internal distribution class.
## S3 method for class 'epiparameter'
family(object, ..., base_dist = FALSE)
object |
An |
... |
further arguments passed to methods. |
base_dist |
A boolean |
A character string with the name of the distribution, or NA
when
the <epiparameter>
object is unparameterised.
# example with continuous distribution
ep <- epiparameter(
disease = "ebola",
epi_name = "incubation_period",
prob_distribution = create_prob_distribution(
prob_distribution = "gamma",
prob_distribution_params = c(shape = 1, scale = 1)
)
)
family(ep)
# example with discretised distribution
ep <- epiparameter(
disease = "ebola",
epi_name = "incubation_period",
prob_distribution = create_prob_distribution(
prob_distribution = "lnorm",
prob_distribution_params = c(meanlog = 1, sdlog = 1),
discretise = TRUE
)
)
family(ep)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.