Achilles (version 1.6.3)

addDataSource: addDataSource

Description

addDataSource adds a data source to the datasource.json file.

Usage

addDataSource(jsonFolderPath, dataName = NULL, dataSourcePath = NULL,
  dataSourcesFileName = "datasources.json",
  additionalParam = list(cdmVersion = 5))

Arguments

jsonFolderPath

Path of the Json files generated by exportToJson.

dataName

Name of Achilles report. Default is the base folder of jsonFolderPath.

dataSourcePath

Path where datasource file will be saved. Default is one folder above the jsonFolderPath

additionalParam

A R list specifying which additinal parameters to write to the datasource object. Default is list(cdmVersion=5).

dataSourcesFilename

Name of the file where the datasource is located or stored. Default is "datasources.json".

Value

none

Details

Used to update the datasources file with the reference to a specified datasource. This makes the new datasource findable for OHDSI tools. If the datasources file exists, the data source will be added to the file. If the datasources file does not exist, a new file wil be initialized with the specified data source.

Examples

# NOT RUN {
                           
# }
# NOT RUN {
                                        jsonFolderPath <- "your/output/path"
                                        connectionDetails <- DatabaseConnector::createConnectionDetails(dbms="sql server", server="yourserver")
                                        exportToJson(connectionDetails, cdmDatabaseSchema="cdm5", outputPath=jsonFolderPath)
                                        addDatasource(jsonFolderPath, "your_data_name")
                                     
# }