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

docs: ✨ initial draft of functions to classify diabetes type #75

Merged
merged 48 commits into from
Jun 14, 2024

Conversation

signekb
Copy link
Contributor

@signekb signekb commented Apr 12, 2024

Description

This PR describes the functions for classifying the diabetes type from the diabetes population using the osdc package.
This is a stacked PR (meaning that it builds upon the PR that describes how the diabetes population is extracted, #71).

Closes #26.

As we have discussed, this is an initial draft meant to help us specify exactly what we want to build.

So, as with the other PR, please chime in with questions, suggestions, and corrections :)))

@signekb signekb marked this pull request as ready for review April 12, 2024 15:24
@signekb signekb changed the title docs: ✨ initial draft of diabetes type functionality flow (post and figure) docs: ✨ initial draft of functions to classify diabetes type Apr 15, 2024
Copy link
Collaborator

@Aastedet Aastedet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I add the summary from Steering group meeting (including roadmap for improvements e.g. birth register and date of diagnosis) to #69

vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
@signekb
Copy link
Contributor Author

signekb commented Apr 17, 2024

Based on update meeting: I will add the final data.frame: PNR, inclusion date (two columns: stable and raw), and type

@signekb
Copy link
Contributor Author

signekb commented Apr 17, 2024

@Aastedet @lwjohnst86 ready for another review 🎉

@Aastedet rather than creating an "extended" version of the flow chart for classifying the diabetes type, I have added a section elaborating on the "hierarchy" or "ordering" of primary diagnosis from endocrinological and medical specialties. What do you think? Is that sufficient?

@signekb signekb requested a review from Aastedet April 17, 2024 13:58
Copy link
Collaborator

@Aastedet Aastedet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a bit of date formatting

vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
docs: change date format based on @Aastedet s review

Co-authored-by: Anders Aasted Isaksen <[email protected]>
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
Comment on lines +254 to +256
3. **raw_inclusion_date**: The *raw* inclusion date (i.e., the date of
the second inclusion event as described in the [Extracting the
diabetes population](#extracting-diabetes-population) section above)
Copy link
Collaborator

@Aastedet Aastedet May 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lwjohnst86 At the Steering Group meeting we decided to provide both, but the "stable_inclusion" being the clear default, while we are explicit to the user that the "raw_inclusion" is experimental/use-at-own-risk.

I'm not sure if that guides us towards an answer here though. Depending on the study design, the user might have a clear need for the "raw_inclusion" date.

I lean towards including both, but naming them to "inclusion_date" and something like "unstable_date" or "_date" to make it clear which is the default (and also obscuring the non-default variable name so users will have to read the documentation to know what the variable is).

Copy link
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I've only done very small formatting and text edits. Otherwise looks good now!!!

@lwjohnst86 lwjohnst86 merged commit 24a4083 into main Jun 14, 2024
1 check failed
@lwjohnst86 lwjohnst86 deleted the docs/functionality-flow-classify-diabetes-type branch June 14, 2024 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Create simple flow diagram for the general functionality
3 participants