exportToJson {Achilles} | R Documentation |
exportToJson
Description
exportToJson
Exports Achilles statistics into a JSON form for reports.
Usage
exportToJson(
connectionDetails,
cdmDatabaseSchema,
resultsDatabaseSchema,
outputPath,
reports = getAllReports(),
vocabDatabaseSchema = cdmDatabaseSchema,
compressIntoOneFile = FALSE
)
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 OMOP CDM. |
resultsDatabaseSchema |
Name of the database schema that contains the Achilles analysis files. Default is cdmDatabaseSchema |
outputPath |
A folder location to save the JSON files. Default is current working folder |
reports |
A character vector listing the set of reports to generate. Default is all reports. |
vocabDatabaseSchema |
string 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'. |
compressIntoOneFile |
Boolean indicating if the JSON files should be compressed into one
zip file. Please note that in Windows, the zip application must be
stored in the system environment, e.g. Sys.setenv("R_ZIPCMD",
"some_path_to_zip"). Due to recursion, the actual Achilles files and
folders will be embedded in any parent directories that the source
folder has. See |
Details
Creates individual files for each report found in Achilles.Web
Value
none
Examples
## Not run:
connectionDetails <- DatabaseConnector::createConnectionDetails(dbms = "sql server",
server = "yourserver")
exportToJson(connectionDetails, cdmDatabaseSchema = "cdm4_sim", outputPath = "your/output/path")
## End(Not run)