Get site information
getSiteInfo(expectConfigFile = TRUE)A named list of 20 elements of site specific information used by the application.
The first seven elements (center, baseUrl,
schemaName, folderPath, queryName,
lkPedColumns and mapPedColumns) are read from the
configuration file when one exists. A configuration file that lacks one of
these keys causes an error ("Could not find ..."). When no configuration
file exists, the defaults for the ONPRC are returned instead: center
"ONPRC", baseUrl "https://primeuat.ohsu.edu", schemaName "study",
folderPath "/ONPRC/EHR" and queryName "demographics". A warning is
signaled for the missing file only when expectConfigFile is
TRUE.
The format of the configuration file is described in the notes at the top
of the example file, example_nprcgenekeepr_config, in the package's
extdata/examples folder.
The returned list contains the following elements.
center -- center name, such as "ONPRC" or "SNPRC"
baseUrl -- base URL of the LabKey server
schemaName -- LabKey schema name
folderPath -- LabKey folder path
queryName -- LabKey query name, "demographics" by default
lkPedColumns -- LabKey column names for the pedigree
mapPedColumns -- the package column names that
lkPedColumns are renamed to
sysname, release, version,
nodename, machine, login, user and
effective_user -- character strings from Sys.info()
homeDir and configFile -- the home directory and
the expected configuration file path, from
getConfigFileName
requiredCols -- the required studbook columns, from
getRequiredCols
possibleCols -- the possible studbook columns, from
getPossibleCols
includeColumns -- the superset of report-inclusion columns,
from getIncludeColumns
logical parameter when set to FALSE, no
configuration is looked for. Default value is TRUE.
library(nprcgenekeepr)
## default sends warning if configuration file is missing
suppressWarnings(getSiteInfo())
getSiteInfo(expectConfigFile = FALSE)
Run the code above in your browser using DataLab