Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation - required time windows #1113

Open
gowthamrao opened this issue Apr 23, 2024 · 0 comments
Open

Improve documentation - required time windows #1113

gowthamrao opened this issue Apr 23, 2024 · 0 comments

Comments

@gowthamrao
Copy link
Member

Many users have expressed surprise when they discover that CohortDiagnostics computes characterization for time windows that were not explicitly specified. This issue arises because certain time windows are required, as indicated in the code section: RunDiagnostics.R#L409-L419.

# Adding required temporal windows required in results viewer
requiredTemporalPairs <-
list(
c(-365, 0),
c(-30, 0),
c(-365, -31),
c(-30, -1),
c(0, 0),
c(1, 30),
c(31, 365),
c(-9999, 9999)

For example, even when the default covariate settings are modified, these required time windows are still computed:

customCovariateSettings <- CohortDiagnostics::getDefaultCovariateSettings()
customCovariateSettings$temporalStartDays <- c(-1095, -30)
customCovariateSettings$temporalEndDays <- c(0, 0)

Originally (and continues to be), CohortDiagnostics was intended for phenotype development and evaluation, and the FeatureExtraction covariate settings were not exposed. Over time, likely due to demand for using CohortDiagnostics as a characterization tool, these settings were made public. However, a design decision to enforce certain time windows was implemented. As a result, users are often surprised by seeing outputs for time windows they did not specify.

It would be beneficial to either improve the documentation to clearly state this behavior or reconsider the design to allow more flexibility in specifying time windows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant