epiparameter0.4.1 package

Classes and Helper Functions for Working with Epidemiological Parameters

aggregate.multi_epiparameter

Aggregate multiple <epiparameter> objects into a single `<epiparamet...

as_epiparameter.data.frame

Convert <data.frame> to an <epiparameter> object

as_epiparameter

Convert to an <epiparameter> object

as.data.frame.epiparameter

as.data.frame() method for <epiparameter> class

as.data.frame.multi_epiparameter

as.data.frame() method for <multi_epiparameter> class

as.function.epiparameter

as.function() method for <epiparameter> class

assert_epiparameter

Assert an object is a valid <epiparameter> object

c.epiparameter

c() method for <epiparameter> class

calc_disc_dist_quantile

Calculate the quantiles of a probability distribution based on the vec...

convert_params_to_summary_stats

Convert the parameter(s) of a distribution to summary statistics

convert_summary_stats_to_params

Convert the summary statistics of a distribution to parameters

create_citation

Create a citation for an <epiparameter> object

create_metadata

Specify metadata associated with data set

create_method_assess

Specify methodological aspects of distribution fitting

create_prob_distribution

Create a distribution object

create_region

Specify the geography of the data entry

create_summary_stats

Specify reported summary statistics

create_uncertainty

Specify distribution parameter uncertainty

discretise

Discretises a continuous distribution in an <epiparameter> object

dot-calc_dist_params

Calculate the parameters of a probability distribution from a list of ...

dot-check_optim_conv

Check whether the optimisation of distribution parameters has converge...

dot-citet

Format short citation from <bibentry> object

dot-clean_params

Standardise distribution parameters

dot-clean_string

Standardise the variables input by users

dot-clean_uncertainty

Standardise distribution parameter uncertainty

dot-convert_params_gamma

Convert parameters of the gamma distribution to summary statistics

dot-convert_params_geom

Convert parameter of the geometric distribution to summary statistics

dot-convert_params_lnorm

Converts the parameters of the lognormal distribution to summary stati...

dot-convert_params_nbinom

Convert parameters of the negative binomial distribution to summary st...

dot-convert_params_weibull

Convert parameters of the Weibull distribution to summary statistics

dot-convert_summary_stats_gamma

Convert summary statistics to parameters of the gamma distribution

dot-convert_summary_stats_geom

Convert summary statistics to parameters of the geometric distribution

dot-convert_summary_stats_lnorm

Convert summary statistics to parameters of the lognormal distribution

dot-convert_summary_stats_nbinom

Convert summary statistics to parameters of the negative binomial dist...

dot-convert_summary_stats_weibull

Convert summary statistics to parameters of the Weibull distribution

dot-distributional_family

Get the underlying distributions names from a <distribution> object ...

dot-epiparameter_df_to_epiparameter

Convert <data.frame> from as.data.frame.epiparameter() to `<epipar...

dot-extract_param

Optimises the parameters for a specified probability distribution give...

dot-get_percentiles

Convert a vector of named percentiles into correct format and selects ...

dot-get_sym_percentiles

Get the lower and upper percentiles with a preference for symmetrical ...

dot-is_epireview

Check if <data.frame> input is from epireview

epidist_db

Create <epiparameter> object(s) directly from the epiparameter libra...

epiparameter_db

Create <epiparameter> object(s) directly from the epiparameter libra...

epiparameter_distribution_functions

PDF, CDF, PMF, quantiles and random number generation for `<epiparamet...

epiparameter_options

Package options

epiparameter-package

epiparameter: Classes and Helper Functions for Working with Epidemiolo...

epiparameter

Create an <epiparameter> object

extract_param

Calculate the parameters of a parametric probability distribution from...

extraction_functions

Function for extracting distribution parameters

family.epiparameter

Family method for the <epiparameter> class

format.epiparameter

Format method for <epiparameter> class

get_citation.epiparameter

Get citation from an <epiparameter> object

get_citation.multi_epiparameter

Get citation from a list of <epiparameter> objects

get_citation

Get citation from an object

get_parameters.epiparameter

Get parameters from an <epiparameter> object

get_parameters

Get parameters from an object

is_continuous

Check if distribution in <epiparameter> is continuous

is_epiparameter_df

Check if <data.frame> input is from as.data.frame.epiparameter()

is_epiparameter_params

Check whether the vector of parameters for the probability distributio...

is_epiparameter

Check object is an <epiparameter>

is_parameterised

Check if <epiparameter> or list of <epiparameter> objects contains...

is_truncated

Check if distribution in <epiparameter> is truncated

lines.epiparameter

lines() method for <epiparameter> class

mean.epiparameter

Mean method for <epiparameter> class

new_epiparameter

Constructor for <epiparameter> class

parameter_tbl

Table of epidemiological distributions

plot.epiparameter

Plot method for <epiparameter> class

plot.multi_epiparameter

plot() method for <multi_epiparameter> class

print.epiparameter

Print method for <epiparameter> class

print.multi_epiparameter

Print method for <multi_epiparameter> class

reexports

Objects exported from other packages

test_epiparameter

Test whether an object is a valid <epiparameter> object

Classes and helper functions for loading, extracting, converting, manipulating, plotting and aggregating epidemiological parameters for infectious diseases. Epidemiological parameters extracted from the literature are loaded from the 'epiparameterDB' R package.

  • Maintainer: Joshua W. Lambert
  • License: MIT + file LICENSE
  • Last published: 2025-01-24