executeTreatmentPatterns: This is the main function which runs all different parts of...

In mi-erasmusmc/AsthmaCOPDTreatmentPatterns: A package to analyse real-world treatment patterns for patients with asthma, COPD and Asthma-COPD Overlap.

This is the main function which runs all different parts of the treatment pathways analysis.

Description

This is the main function which runs all different parts of the treatment pathways analysis.

Usage

executeTreatmentPatterns(
  connection = NULL,
  connectionDetails = NULL,
  cdmDatabaseSchema,
  cohortDatabaseSchema = cdmDatabaseSchema,
  cohortTable = "cohort",
  outputFolder,
  databaseName = "Unknown",
  runCreateCohorts = TRUE,
  runCohortCharacterization = FALSE,
  runConstructPathways = TRUE,
  runGenerateResults = TRUE,
  study_settings
)

Arguments

connection	Connection to database server.
connectionDetails	An object of type connectionDetails as created using the createConnectionDetails function in the DatabaseConnector package.
cdmDatabaseSchema	Schema name where your patient-level data resides. Note that for SQL Server, this should include both the database and schema name, for example 'cdm_data.dbo'.
cohortDatabaseSchema	Schema name where intermediate data can be stored. You will need to have write priviliges in this schema. Note that for SQL Server, this should include both the database and schema name, for example 'cdm_data.dbo'.
cohortTable	The name of the table that will be created in the work database schema. This table will hold the target and event cohorts used in this study.
outputFolder	Name of local folder to place results; make sure to use forward slashes (/).
databaseName	Name of the database that will appear in the results.
runCreateCohorts	Setting to run part of the analysis where cohorts are created.
runCohortCharacterization	Setting to run part of the analysis where characterization of target cohorts is done.
runConstructPathways	Setting to run part of the analysis where treatment pathways are constructed.
runGenerateResults	Setting to run part of the analysis where final result files and plots are generated.
study_settings	Object that contains all study settings inputted by the user.

mi-erasmusmc/AsthmaCOPDTreatmentPatterns documentation built on Feb. 25, 2024, 2:34 p.m.