-
Notifications
You must be signed in to change notification settings - Fork 75
/
Copy pathLoadEventTables.Rd
60 lines (50 loc) · 2.48 KB
/
LoadEventTables.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/LoadEventTables.r
\name{LoadEventTables}
\alias{LoadEventTables}
\title{Load CDM Non-Vocabulary Tables.}
\usage{
LoadEventTables(
connectionDetails,
cdmSchema,
syntheaSchema,
cdmVersion,
syntheaVersion = "2.7.0",
cdmSourceName = "Synthea synthetic health database",
cdmSourceAbbreviation = "Synthea",
cdmHolder = "OHDSI",
cdmSourceDescription =
"SyntheaTM is a Synthetic Patient Population Simulator. The goal is to output synthetic, realistic (but not real), patient data and associated health records in a variety of formats.",
createIndices = FALSE,
sqlOnly = FALSE
)
}
\arguments{
\item{connectionDetails}{An R object of type\cr\code{connectionDetails} created using the
function \code{createConnectionDetails} in the
\code{DatabaseConnector} package.}
\item{cdmSchema}{The name of the database schema that will contain the CDM.
Requires read and write permissions to this database. On SQL
Server, this should specify both the database and the schema,
so for example 'cdm_instance.dbo'.}
\item{syntheaSchema}{The name of the database schema that contain the Synthea
instance. Requires read and write permissions to this database. On SQL
Server, this should specify both the database and the schema,
so for example 'cdm_instance.dbo'.}
\item{cdmVersion}{The version of your CDM. Currently "5.3" and "5.4".}
\item{syntheaVersion}{The version of Synthea used to generate the csv files.
Currently "2.7.0","3.0.0","3.1.0","3.2.0" and "3.3.0" are supported.}
\item{cdmSourceName}{The source name to insert into the CDM_SOURCE table. Default is Synthea synthetic health database.}
\item{cdmSourceAbbreviation}{The source abbreviation to insert into the CDM_SOURCE table. Default is Synthea.}
\item{cdmHolder}{The holder to insert into the CDM_SOURCE table. Default is OHDSI}
\item{cdmSourceDescription}{The description of the source data. Default is generic Synthea description.}
\item{createIndices}{A boolean that determines whether or not to create indices on CDM tables before the ETL.}
\item{sqlOnly}{A boolean that determines whether or not to perform the load or generate SQL scripts. Default is FALSE.}
}
\description{
This function loads the CDM Event tables with Synthea data.
}
\details{
This function assumes \cr\code{createCDMTables()}, \cr\code{createSyntheaTables()}, \cr\code{LoadSyntheaTables()},
\cr\code{LoadVocabTables()}, and \cr\code{CreateMapAndRollupTables()} have all been run.
}