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 extract osdc population #71

Merged
merged 58 commits into from
May 2, 2024

Conversation

signekb
Copy link
Contributor

@signekb signekb commented Apr 3, 2024

Description

This PR describes the functions for extracting a diabetes population using the osdc package.

See issue #67.

As we have discussed, this is an initial draft meant to help us specify exactly what we want to build.
So please chime in with questions, suggestions, and corrections.

As @Aastedet wrote here there is an overlap between #69 and this PR. @lwjohnst86 can you help us in terms of what should be in each post?

@signekb signekb changed the title docs: ✨ Init overview of functions to create osdc population docs: ✨ Initial draft of functions to extract osdc population Apr 3, 2024
@signekb signekb marked this pull request as ready for review April 3, 2024 14:11
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.

Awesome! I've added a few comments just to FYI a few details.

I think that #69 will eventually merge/move into this document.

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
vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
vignettes/functionality-flow.Rmd Outdated Show resolved Hide resolved
@lwjohnst86
Copy link
Member

I revised the doc and images a bit, mostly adding the input register source, converting it to a flow chart to show the interconnection with some of the functions and output data as input to other functions. I also added a function convention section so we have at least a guidelines for naming things.

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.

There's still a few questions left and this doc still has things to improve on and add, but I am in favour of approving and merging after @Aastedet (and @signekb) agree with the correct changes.

Comment on lines +111 to +112
- `calculate_pregnancy_index_date_for_mc_visits_wo_end_date()` (this
might be removed with the inclusion of the birth register)
Copy link
Member

Choose a reason for hiding this comment

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

I don't really know what this does.

Copy link
Member

Choose a reason for hiding this comment

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

@Aastedet you'll have to confirm if the input registers are correct for each inclusion/exclusion function.

Copy link
Contributor Author

@signekb signekb left a comment

Choose a reason for hiding this comment

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

Very niceeee @lwjohnst86. I really like the clarity of the naming scheme 🎉

vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Show resolved Hide resolved
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
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
vignettes/images/function-flow.png Outdated Show resolved Hide resolved
Co-authored-by: Signe Kirk Brødbæk <[email protected]>
vignettes/function-flow.Rmd Show resolved Hide resolved
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Show resolved Hide resolved
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
vignettes/images/function-flow.png Outdated Show resolved Hide resolved
@signekb
Copy link
Contributor Author

signekb commented May 2, 2024

@lwjohnst86 @Aastedet I have updated this again based on the feedback I got from Luke, so I'll re-request reviews :)

@signekb signekb requested a review from lwjohnst86 May 2, 2024 12:59
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!

vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/function-flow.Rmd Outdated Show resolved Hide resolved
vignettes/images/function-flow.puml Outdated Show resolved Hide resolved
vignettes/images/function-flow.puml Outdated Show resolved Hide resolved
vignettes/images/function-flow.puml Outdated Show resolved Hide resolved
vignettes/images/function-flow.puml Outdated Show resolved Hide resolved
@lwjohnst86 lwjohnst86 merged commit be750d0 into main May 2, 2024
2 of 3 checks passed
@lwjohnst86 lwjohnst86 deleted the docs/functionality-flow-diabetes-population branch May 2, 2024 14:23
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.

3 participants