epichains0.1.1 package

Simulating and Analysing Transmission Chain Statistics Using Branching Process Models

dot-check_sim_args

Check inputs to simulate_chains() and simulate_summary()

dot-check_statistic_args

Check that the statistic and stat_threshold arguments are valid

dot-init_susc_pop

Adjust next generation vector to match susceptible population size

dot-is_epichains_summary

Test if x is an epichains_summary object

dot-is_epichains

Test if x is an epichains object

dot-nbinom_size_ll

Log-likelihood of the size of chains with Negative-Binomial offspring ...

dot-rgen_length

Samples chain lengths with given observation probabilities

dot-sample_possible_offspring

Sample all possible offspring for the next generation

dot-update_chain_stat

Determine and update the chain statistic being tracked

dot-validate_epichains_summary

Validate an <epichains_summary> object

dot-validate_epichains

Validate an <epichains> object

epichains-package

epichains: Simulating and Analysing Transmission Chain Statistics Usin...

head.epichains

head and tail method for <epichains> class

likelihood

Estimate the log-likelihood/likelihood for observed branching processe...

print.epichains_summary

Print an <epichains_summary> object

print.epichains

Print an <epichains> object

rborel

Generate random numbers from the Borel distribution

rgborel

Generate random numbers from a Gamma-Borel mixture distribution

simulate_chain_stats

Simulate a vector of transmission chains statistics (sizes/lengths)

simulate_chains

Simulate transmission chains

summary.epichains_summary

Summary method for <epichains_summary> class

aggregate.epichains

Aggregate cases in <epichains> objects by "generation" or "time", if...

dborel

Density of the Borel distribution

dot-adjust_next_gen

Adjust new offspring if it exceeds the susceptible population size

dot-check_generation_time_valid

Check if the generation_time argument is specified as a function

dot-check_offspring_func_valid

Check if constructed random number generator for offspring exists and ...

dot-check_time_args

Check inputs that control time events

dot-complementary_logprob

Calculates the complementary log-probability

dot-epichains_summary

Create an <epichains_summary> object

dot-epichains

Create an <epichains> object

dot-gborel_size_ll

Log-likelihood of the size of chains with gamma-Borel offspring distri...

dot-geom_length_ll

Log-likelihood of the length of chains with geometric offspring distri...

dot-get_statistic_func

Return a function for calculating chain statistics

dot-get_susceptible_offspring

Sample the number of susceptible offspring from all possible offspring

dot-new_epichains_summary

Construct a <epichains_summary> object

dot-new_epichains

Construct an <epichains> object

dot-offspring_ll

Log-likelihood of the summary (size/length) of chains with generic off...

dot-pois_length_ll

Log-likelihood of the length of chains with Poisson offspring distribu...

dot-pois_size_ll

Log-likelihood of the size of chains with Poisson offspring distributi...

dot-rbinom_size

Samples size (the number of trials) of a binomial distribution

summary.epichains

Summary method for <epichains> class

Provides methods to simulate and analyse the size and length of branching processes with an arbitrary offspring distribution. These can be used, for example, to analyse the distribution of chain sizes or length of infectious disease outbreaks, as discussed in Farrington et al. (2003) <doi:10.1093/biostatistics/4.2.279>.

  • Maintainer: James M. Azam
  • License: MIT + file LICENSE
  • Last published: 2024-10-14