documentation update #243
documentation update #243
Conversation
|
@anthonysena do you think this is enough with regard to updating the documentation or should we describe it somewhere else as well? |
R/GetCovariates.R
Outdated
| @@ -58,7 +58,8 @@ | |||
| #' @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? | |||
| #' cohort entry? If aggregated is set to FALSE, the cohort table should contain unique records | |||
| #' per patient and per cohort. Otherwise there will be collisions and the output is ambiguous. | |||
There was a problem hiding this comment.
If aggregated is set to FALSE, the cohort table should contain unique records per patient and per cohort. Otherwise there will be collisions and the output is ambiguous.
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.
There was a problem hiding this comment.
hi @anthonysena I have updated the documentation to the text above
Merge branch 'develop' into issue229 # Conflicts: # R/GetCovariates.R
see #229