createCreatePsArgs: Create a parameter object for the function createPs

In OHDSI/RiskStratifiedEstimation: Risk Stratified Effect Estimation

Create a parameter object for the function createPs

Description

Create a parameter object for the function createPs

Usage

createCreatePsArgs(
  excludeCovariateIds = c(),
  includeCovariateIds = c(),
  maxCohortSizeForFitting = 250000,
  errorOnHighCorrelation = TRUE,
  stopOnError = TRUE,
  prior = createPrior("laplace", exclude = c(0), useCrossValidation = TRUE),
  control = createControl(noiseLevel = "silent", cvType = "auto", tolerance = 2e-07,
    cvRepetitions = 10, startingVariance = 0.01)
)

Arguments

excludeCovariateIds	Exclude these covariates from the propensity model.
includeCovariateIds	Include only these covariates in the propensity model.
maxCohortSizeForFitting	If the target or comparator cohort are larger than this number, they will be downsampled before fitting the propensity model. The model will be used to compute propensity scores for all subjects. The purpose of the sampling is to gain speed. Setting this number to 0 means no downsampling will be applied.
errorOnHighCorrelation	If true, the function will test each covariate for correlation with the treatment assignment. If any covariate has an unusually highcorrelation (either positive or negative), this will throw an error.
stopOnError	If an error occurrs, should the function stop? Else, the two cohorts will be assumed to be perfectly separable.
prior	The prior used to fit the model. See createPrior for details.
control	The control object used to control the cross-validation used to determine the hyperparameters of the prior (if applicable). See createControl for details.

Details

Create an object defining the parameter values.

Value

A parameter object for creating propensity scores.

OHDSI/RiskStratifiedEstimation documentation built on March 13, 2023, 8:16 a.m.