Skip to contents

Format method for <epiparameter> class

Source: R/epiparameter.R
format.epiparameter.Rd

Format method for <epiparameter> class

Usage

# S3 method for class 'epiparameter'
format(x, ...)

Arguments

x

An <epiparameter> object.

...

dots Extra arguments to be passed to the method.

Value

Invisibly returns an <epiparameter>. Called for printing side-effects.

Examples

epiparameter <- epiparameter(
  disease = "ebola",
  epi_name = "incubation_period",
  prob_distribution = create_prob_distribution(
    prob_distribution = "gamma",
    prob_distribution_params = c(shape = 1, scale = 1)
  )
)
#> Citation cannot be created as author, year, journal or title is missing
format(epiparameter)
#> Disease: ebola
#> Pathogen: NA
#> Epi Parameter: incubation period
#> Study: (????). “No citation.”
#> Distribution: gamma
#> Parameters:
#>   shape: 1.000
#>   scale: 1.000