Creates a model plan for hazard ratio

Creates a model plan for hazard ratio

plan_hr(
  bth.model = c("FE", "RE"),
  engine = "gemtc",
  data.type = "HR",
  binary_data_type = "relative_effect",
  jags_init = NULL,
  n.chain = NULL,
  n.iter = NULL,
  n.adapt = NULL,
  thin = NULL,
  bth.prior = NULL,
  rsd = 13579,
  model = "binom",
  link = "identity",
  om.scale = 5,
  ...
)

Arguments

bth.model

One of "FE", or "RE"

engine

Only `gemtc` currently supported

data.type

Only "HR" supported

binary_data_type

One of "relative_effect" or "arm_level"

jags_init

A list containing the jags seeds to set.

n.chain

A numeric value representing n.chains

n.iter

A numeric value representing n.iter

n.adapt

A numeric value representing n.adpat/ n.burnin

thin

A numeric value representing thin

bth.prior

Output of using mtc.hy.prior. Only required if bth.model == "RE"

rsd

numeric seed to be set

model

defult "binom"

link

default "logit"

om.scale

defult is 5

...

any other names arguments must match arguments names from mtc.model

Value

A list containing model, engine, binary_data_type and model params

Examples

plan_hr(bth.model = "RE", 
        n.chain = 3, 
        n.iter = 6000, thin = 1,  n.adapt = 1000,
        link = "identity",
        linearModel = "random",
        bth.prior =  gemtc::mtc.hy.prior(type = "var", distr = "dlnorm",-4.18, 1 / 1.41 ^ 2))
#> $engine
#> [1] "gemtc"
#> 
#> $analysis
#> [1] "HR"
#> 
#> $binary_data_type
#> [1] "data.re"
#> 
#> $params
#> $params$seed
#> [1] 13579
#> 
#> $params$model_params
#> $params$model_params$n.chain
#> [1] 3
#> 
#> $params$model_params$hy.prior
#> $type
#> [1] "var"
#> 
#> $distr
#> [1] "dlnorm"
#> 
#> $args
#> $args[[1]]
#> [1] -4.18
#> 
#> $args[[2]]
#> [1] 0.5029928
#> 
#> 
#> attr(,"class")
#> [1] "mtc.hy.prior"
#> 
#> $params$model_params$link
#> [1] "identity"
#> 
#> $params$model_params$om.scale
#> [1] 5
#> 
#> $params$model_params$linearModel
#> [1] "random"
#> 
#> 
#> $params$run_params
#> $params$run_params$n.iter
#> [1] 6000
#> 
#> $params$run_params$n.adapt
#> [1] 1000
#> 
#> $params$run_params$thin
#> [1] 1
#> 
#> $params$run_params$model
#> [1] "binom"
#> 
#> 
#> $params$jags_init
#> $params$jags_init[[1]]
#> $params$jags_init[[1]]$.RNG.name
#> [1] "base::Wichmann-Hill"
#> 
#> $params$jags_init[[1]]$.RNG.seed
#> [1] 94387
#> 
#> 
#> $params$jags_init[[2]]
#> $params$jags_init[[2]]$.RNG.name
#> [1] "base::Wichmann-Hill"
#> 
#> $params$jags_init[[2]]$.RNG.seed
#> [1] 24507
#> 
#> 
#> $params$jags_init[[3]]
#> $params$jags_init[[3]]$.RNG.name
#> [1] "base::Wichmann-Hill"
#> 
#> $params$jags_init[[3]]$.RNG.seed
#> [1] 39483
#> 
#> 
#> 
#>