exportDashboardToJson: exportDashboardToJson

In Achilles: Achilles Data Source Characterization

exportDashboardToJson

Description

exportDashboardToJson Exports Achilles Dashboard report into a JSON form for reports.

Usage

exportDashboardToJson(
  connectionDetails,
  cdmDatabaseSchema,
  resultsDatabaseSchema,
  outputPath,
  vocabDatabaseSchema = cdmDatabaseSchema
)

Arguments

connectionDetails	An R object of type ConnectionDetail (details for the function that contains server info, database type, optionally username/password, port)
cdmDatabaseSchema	Name of the database schema that contains the vocabulary files
resultsDatabaseSchema	Name of the database schema that contains the Achilles analysis files. Default is cdmDatabaseSchema
outputPath	folder location to save the JSON files. Default is current working folder
vocabDatabaseSchema	name of database schema that contains OMOP Vocabulary. Default is cdmDatabaseSchema. On SQL Server, this should specifiy both the database and the schema, so for example 'results.dbo'.

Details

Creates individual files for Dashboard report found in Achilles.Web. NOTE: This function reads the results from the other exports and aggregates them into a single file. If other reports are not genreated, this function will fail.

Value

none

Examples

## Not run: 
connectionDetails <- DatabaseConnector::createConnectionDetails(dbms = "sql server",
                                                                server = "yourserver")
exportDashboardToJson(connectionDetails,
                      cdmDatabaseSchema = "cdm4_sim",
                      outputPath = "your/output/path")

## End(Not run)

Achilles documentation built on May 31, 2023, 8:57 p.m.