-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add Initial data spec #39
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aclark02-arcus thanks for this, this is a good start indeed.
I've added a view comments. It will need an additional review after you are done with creating your own datasets, but that can be done in a follow-up PR indeed.
Some general points/common thoughts (can also be for future PRs):
- Maybe it's good to put the descriptions in the descriptions of the internal data objects, and refer to them, stating that the columns should look like that.
clinsightful_data
is data that is already merged with metadata. The descriptions in the vignette should probably be focused on how the raw data looks like, so that the functionmerge_meta_with_data()
(or an equivalent one) can shape it in the right format, given the right metadata object. For example: columns such asitem_name
,item_type
anditem_group
should not be in the raw data but are created after merging with metadata.- In addition to point 2.: we should see if it is possible to reduce the number of mandatory columns, to reduce complexity. For example,
form_id
andevent_id
; they are hardly used. - We should evaluate if it is easier/better to define in the metadata which columns together can identify a unique event, and create key columns based on that for internal use.
As discussed on 6/28, @aclark02-arcus will move all this documentation into a vignette instead of as documentation for the |
I'm going to focus on this to round out and complete this PR. All other requests above have been addressed. |
@aclark02-arcus thanks for your work. If you are okay with it, I can finalize the PR (update a few sentences to reflect the current state, fix the R CMD check, add a few clarifications). |
@LDSamson, yes! Please do & thank you! |
Makes progress on #21.
Please review and let me know if these column specs for the
study_data
object are inaccurate. I was just doing some light exploration in02_dev.R
in order to understand the data better. I can remove that code before we merge this PR.This is a work in progress. I still need to define specs for the
meta
object, but happy to push that duty down the road or to someone else.