executeChecks {DrugExposureDiagnostics} | R Documentation |
Execute given checks on Drug Exposure.
Description
Execute given checks on Drug Exposure.
Usage
executeChecks(
cdm,
ingredients = c(1125315),
subsetToConceptId = NULL,
checks = c("missing", "exposureDuration", "quantity"),
minCellCount = 5,
sample = 10000,
tablePrefix = NULL,
earliestStartDate = "2010-01-01",
verbose = FALSE,
byConcept = TRUE
)
Arguments
cdm |
CDMConnector reference object |
ingredients |
vector of ingredients, by default: acetaminophen |
subsetToConceptId |
vector of concept IDs of the ingredients to filter. If a concept ID is positive it will be included, a negative one will be excluded. If NULL, all concept IDs for an ingredient will be considered. |
checks |
the checks to be executed, by default the missing values, the exposure duration and the quantity. Possible options are "missing", "exposureDuration", "type", "route", "sourceConcept", "daysSupply", "verbatimEndDate", "dose", "sig", "quantity" and "diagnosticsSummary" |
minCellCount |
minimum number of events to report- results lower than this will be obscured. If NULL all results will be reported. |
sample |
the number of samples, default 10.000 |
tablePrefix |
The stem for the permanent tables that will be created when running the diagnostics. Permanent tables will be created using this prefix, and any existing tables that start with this will be at risk of being dropped or overwritten. If NULL, temporary tables will be used throughout. |
earliestStartDate |
the earliest date from which a record can be included |
verbose |
verbose, default FALSE |
byConcept |
boolean argument whether to return results by Concept or overall only |
Value
named list with results
Examples
## Not run:
db <- DBI::dbConnect(" Your database connection here ")
cdm <- CDMConnector::cdm_from_con(
con = db,
cdm_schema = "cdm schema name"
)
result <- executeChecks(
cdm = cdm,
ingredients = c(1125315))
## End(Not run)