Skip to content

Commit

Permalink
Update docs for aggregated setting (#243)
Browse files Browse the repository at this point in the history
  • Loading branch information
ginberg authored Jun 7, 2024
1 parent c6668ed commit 63bd453
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 9 deletions.
8 changes: 6 additions & 2 deletions R/GetCovariates.R
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,12 @@
#' @param covariateSettings Either an object of type \code{covariateSettings} as created using one
#' of the createCovariate functions, or a list of such objects.
#' @param aggregated Should aggregate statistics be computed instead of covariates per
#' cohort entry?
#' @param minCharacterizationMean The minimum mean value for characterization output. Values below this will be cut off from output. This
#' cohort entry? If aggregated is set to FALSE, the results returned will be based
#' on each subject_id and cohort_start_date in your cohort table. If your cohort
#' contains multiple entries for the same subject_id (due to different cohort_start_date values),
#' you must carefully set the rowIdField so you can identify the patients properly.
#' See issue #229 for more discussion on this parameter.
#' @param minCharacterizationMean The minimum mean value for characterization output. Values below this will be cut off from output. This
#' will help reduce the file size of the characterization output, but will remove information
#' on covariates that have very low values. The default is 0.
#'
Expand Down
6 changes: 5 additions & 1 deletion man/getDbCovariateData.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/testOracle.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ options(dbms = "oracle")
runTestsOnOracle <- !(Sys.getenv("CDM5_ORACLE_USER") == "" & Sys.getenv("CDM5_ORACLE_PASSWORD") == "" & Sys.getenv("CDM5_ORACLE_SERVER") == "" & Sys.getenv("CDM5_ORACLE_CDM_SCHEMA") == "" & Sys.getenv("CDM5_ORACLE_OHDSI_SCHEMA") == "")
if (runTestsOnOracle) {
test_check("FeatureExtraction")
}
}
2 changes: 1 addition & 1 deletion tests/testPostgres.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ options(dbms = "postgresql")
runTestsOnPostgreSQL <- !(Sys.getenv("CDM5_POSTGRESQL_USER") == "" & Sys.getenv("CDM5_POSTGRESQL_PASSWORD") == "" & Sys.getenv("CDM5_POSTGRESQL_SERVER") == "" & Sys.getenv("CDM5_POSTGRESQL_CDM_SCHEMA") == "" & Sys.getenv("CDM5_POSTGRESQL_OHDSI_SCHEMA") == "")
if (runTestsOnPostgreSQL) {
test_check("FeatureExtraction")
}
}
6 changes: 3 additions & 3 deletions tests/testRedshift.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
library(testthat)
options(dbms = "redshift")
runTestsOnRedshift <- FALSE # !(Sys.getenv("CDM5_REDSHIFT_USER") == "" & Sys.getenv("CDM5_REDSHIFT_PASSWORD") == "" & Sys.getenv("CDM5_REDSHIFT_SERVER") == "" & Sys.getenv("CDM5_REDSHIFT_CDM_SCHEMA") == "" & Sys.getenv("CDM5_REDSHIFT_OHDSI_SCHEMA") == "")
if (runTestsOnRedshift) {
runTestsOnRedshift <- FALSE #!(Sys.getenv("CDM5_REDSHIFT_USER") == "" & Sys.getenv("CDM5_REDSHIFT_PASSWORD") == "" & Sys.getenv("CDM5_REDSHIFT_SERVER") == "" & Sys.getenv("CDM5_REDSHIFT_CDM_SCHEMA") == "" & Sys.getenv("CDM5_REDSHIFT_OHDSI_SCHEMA") == "")
if (runTestsOnRedshift) {
test_check("FeatureExtraction")
}
}
2 changes: 1 addition & 1 deletion tests/testSqlServer.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ options(dbms = "sql server")
runTestsOnSQLServer <- !(Sys.getenv("CDM5_SQL_SERVER_USER") == "" & Sys.getenv("CDM5_SQL_SERVER_PASSWORD") == "" & Sys.getenv("CDM5_SQL_SERVER_SERVER") == "" & Sys.getenv("CDM5_SQL_SERVER_CDM_SCHEMA") == "" & Sys.getenv("CDM5_SQL_SERVER_OHDSI_SCHEMA") == "")
if (runTestsOnSQLServer) {
test_check("FeatureExtraction")
}
}

0 comments on commit 63bd453

Please sign in to comment.