Add imports and update docs.
This commit is contained in:
parent
63ba979509
commit
eb3d27926f
|
@ -2,3 +2,4 @@
|
||||||
^\.Rproj\.user$
|
^\.Rproj\.user$
|
||||||
^LICENSE\.md$
|
^LICENSE\.md$
|
||||||
.github/*
|
.github/*
|
||||||
|
extras/*
|
||||||
|
|
|
@ -13,3 +13,6 @@ export(writeDdl)
|
||||||
export(writeForeignKeys)
|
export(writeForeignKeys)
|
||||||
export(writeIndex)
|
export(writeIndex)
|
||||||
export(writePrimaryKeys)
|
export(writePrimaryKeys)
|
||||||
|
importFrom(utils,download.file)
|
||||||
|
importFrom(utils,read.csv)
|
||||||
|
importFrom(utils,write.csv)
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
#'
|
#'
|
||||||
#' @param mdFilesLocation Path to the root folder of the Wiki repository.
|
#' @param mdFilesLocation Path to the root folder of the Wiki repository.
|
||||||
#' @param output_file Path to where the output CSV file should be written.
|
#' @param output_file Path to where the output CSV file should be written.
|
||||||
#'
|
#' @importFrom utils write.csv
|
||||||
#' @export
|
#' @export
|
||||||
parseWiki <- function(mdFilesLocation, output_file) {
|
parseWiki <- function(mdFilesLocation, output_file) {
|
||||||
# mdFilesLocation <- "../CommonDataModel.wiki"
|
# mdFilesLocation <- "../CommonDataModel.wiki"
|
||||||
|
|
|
@ -26,6 +26,7 @@
|
||||||
#'
|
#'
|
||||||
#' @param cdmVersion The version of the CDM you are creating, e.g. 5.3, 5.4
|
#' @param cdmVersion The version of the CDM you are creating, e.g. 5.3, 5.4
|
||||||
#' @return A character string containing the OHDSQL DDL
|
#' @return A character string containing the OHDSQL DDL
|
||||||
|
#' @importFrom utils read.csv
|
||||||
#' @export
|
#' @export
|
||||||
#' @examples
|
#' @examples
|
||||||
#' ddl <- createDdl("5.4")
|
#' ddl <- createDdl("5.4")
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
#' downloadCurrentDdl("OHDSI/CommonDataModel",
|
#' downloadCurrentDdl("OHDSI/CommonDataModel",
|
||||||
#' pathToCsv="Sql%20Server/OMOP%20CDM%20sql%20server%20ddl.txt")
|
#' pathToCsv="Sql%20Server/OMOP%20CDM%20sql%20server%20ddl.txt")
|
||||||
#' }
|
#' }
|
||||||
#'
|
#' @importFrom utils download.file
|
||||||
#' @export
|
#' @export
|
||||||
|
|
||||||
downloadCurrentDdl <- function(githubPath="OHDSI/CommonDataModel",
|
downloadCurrentDdl <- function(githubPath="OHDSI/CommonDataModel",
|
||||||
|
|
|
@ -30,5 +30,4 @@ The default location is
|
||||||
downloadCurrentDdl("OHDSI/CommonDataModel",
|
downloadCurrentDdl("OHDSI/CommonDataModel",
|
||||||
pathToCsv="Sql\%20Server/OMOP\%20CDM\%20sql\%20server\%20ddl.txt")
|
pathToCsv="Sql\%20Server/OMOP\%20CDM\%20sql\%20server\%20ddl.txt")
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,61 @@
|
||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/writeDdl.R
|
||||||
|
\name{writeDdl}
|
||||||
|
\alias{writeDdl}
|
||||||
|
\alias{writePrimaryKeys}
|
||||||
|
\alias{writeForeignKeys}
|
||||||
|
\alias{writeIndex}
|
||||||
|
\title{Write DDL script}
|
||||||
|
\usage{
|
||||||
|
writeDdl(
|
||||||
|
targetDialect,
|
||||||
|
cdmVersion,
|
||||||
|
outputpath,
|
||||||
|
cdmDatabaseSchema = "@cdmDatabaseSchema"
|
||||||
|
)
|
||||||
|
|
||||||
|
writePrimaryKeys(
|
||||||
|
targetDialect,
|
||||||
|
cdmVersion,
|
||||||
|
outputpath,
|
||||||
|
cdmDatabaseSchema = "@cdmDatabaseSchema"
|
||||||
|
)
|
||||||
|
|
||||||
|
writeForeignKeys(
|
||||||
|
targetDialect,
|
||||||
|
cdmVersion,
|
||||||
|
outputpath,
|
||||||
|
cdmDatabaseSchema = "@cdmDatabaseSchema"
|
||||||
|
)
|
||||||
|
|
||||||
|
writeIndex(
|
||||||
|
targetDialect,
|
||||||
|
cdmVersion,
|
||||||
|
outputpath,
|
||||||
|
cdmDatabaseSchema = "@cdmDatabaseSchema"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{targetDialect}{The dialect of the target database. Choices are "oracle", "postgresql", "pdw", "redshift", "impala", "netezza", "bigquery", "sql server"}
|
||||||
|
|
||||||
|
\item{cdmVersion}{The version of the CDM you are creating, e.g. 5.3, 5.4}
|
||||||
|
|
||||||
|
\item{outputpath}{The directory or folder where the SQL file should be saved.}
|
||||||
|
|
||||||
|
\item{cdmDatabaseSchema}{The schema of the CDM instance where the DDL will be run. For example, this would be "ohdsi.dbo" when testing on sql server.
|
||||||
|
Defaults to "@cdmDatabaseSchema"}
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
Write the DDL to a SQL file. The SQL will be rendered (parameters replaced) and translated to the target SQL
|
||||||
|
dialect. By default the @cdmDatabaseSchema parameter is kept in the SQL file and needs to be replaced before
|
||||||
|
execution.
|
||||||
|
}
|
||||||
|
\section{Functions}{
|
||||||
|
\itemize{
|
||||||
|
\item \code{writePrimaryKeys}: writePrimaryKeys Write the SQL code that creates the primary keys to a file.
|
||||||
|
|
||||||
|
\item \code{writeForeignKeys}: writeForeignKeys Write the SQL code that creates the foreign keys to a file.
|
||||||
|
|
||||||
|
\item \code{writeIndex}: writeIndex Write the rendered and translated sql that creates recommended indexes to a file.
|
||||||
|
}}
|
||||||
|
|
Loading…
Reference in New Issue