get_correlation_parameters: Get default correlation parameters

View source: R/correlation.R

get_correlation_parametersR Documentation

Get default correlation parameters

Description

returns a CorrelationParameters object for you edit. By default, all correlations are set to 0

Usage

get_correlation_parameters(parameters)

Arguments

parameters

model parameters

Examples


# get the default model parameters
parameters <- get_parameters()

# Set some vaccination strategy
parameters <- set_mass_pev(
  parameters,
  profile = rtss_profile,
  timesteps = 100,
  coverages = .9,
  min_wait = 0,
  min_ages = 100,
  max_ages = 1000,
  booster_spacing = numeric(0),
  booster_coverage = numeric(0),
  booster_profile = NULL
)

# Set some smc strategy
parameters <- set_drugs(parameters, list(SP_AQ_params))
parameters <- set_smc(
  parameters,
  drug = 1,
  timesteps = 100,
  coverages = .9,
  min_age = 100,
  max_age = 1000
)

# Correlate the vaccination and smc targets
correlations <- get_correlation_parameters(parameters)
correlations$inter_intervention_rho('pev', 'smc', 1)

# Correlate the rounds of smc
correlations$inter_round_rho('smc', 1)

# You can now pass the correlation parameters to the run_simulation function

mrc-ide/malariasimulation documentation built on Oct. 14, 2024, 7:33 p.m.