Skip to content

feat: ✨ describe relationship between weeks, visits, and instruments - #224

Open
K-Beicher wants to merge 11 commits into
mainfrom
feat/create-overview-of-weeks-and-visits
Open

feat: ✨ describe relationship between weeks, visits, and instruments#224
K-Beicher wants to merge 11 commits into
mainfrom
feat/create-overview-of-weeks-and-visits

Conversation

@K-Beicher

@K-Beicher K-Beicher commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Description

Very first draft of the description of the instrument and how they relate to weeks. I expect that there is a lot of questions that will arise from this.

I've avoided the whole making it a csv file for now by splitting the markdown table into two, it felt more important to get the text out for commenting than getting the repo to accept python code.

Closes #220

Needs a lot of comments on what I'm missing and what is unclear.

Checklist

  • Ran just run-all

@K-Beicher K-Beicher self-assigned this Aug 5, 2026
@K-Beicher
K-Beicher requested a review from a team as a code owner August 5, 2026 12:35
@K-Beicher K-Beicher linked an issue Aug 5, 2026 that may be closed by this pull request
@K-Beicher K-Beicher moved this from Todo to In Review in Data development Aug 5, 2026

@lwjohnst86 lwjohnst86 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Here's some initial comments :)

Comment thread supplemental/weeks_instruments.csv Outdated
Comment on lines +3 to +4
W-4,1,"besg_1_screening,
bedq (1. time)",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Keep this tidy (3NF), each cell should have only one instrument. This will mean duplicate weeks and visits, but that's part of the data being tidy.

For example:

Suggested change
W-4,1,"besg_1_screening,
bedq (1. time)",
W-4,1,besg_1_screening,
W-4,1,bedq (1. time),

Repeat this for all the other rows too.

@@ -0,0 +1,88 @@
Weeks,Visit,Instrument name,Comments
W-5,0,prscreening_telefoninterview_frste_kontakt,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should stick with clear data types. Weeks should be an integer:

Suggested change
W-5,0,prscreening_telefoninterview_frste_kontakt,
-5,0,prscreening_telefoninterview_frste_kontakt,

Repeat for the others too.

Comment thread supplemental/weeks_instruments.csv Outdated
Comment thread supplemental/weeks_instruments.csv
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd
Comment thread supplemental/weeks-visits.qmd Outdated
@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Data development Aug 5, 2026
Comment thread supplemental/weeks-visits.qmd
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks-visits.qmd Outdated
Comment thread supplemental/weeks_instruments.csv
Comment thread supplemental/weeks_instruments.csv Outdated
Comment on lines +67 to +88
No week,,stamdata,"Running updates throughout weeks 1-52
This form will contain basic information about the participant as well as information about drop-out or completion of study"
No week,,adverse_events,"Anytime throughout weeks 1-52
This form will register any adverse event the participant experience throughout the study, the form has a date of completion and the dates of the event"
No week,,fase_1_ditetiske_afvigelser,"Anytime through weeks 1-11
This form will register any deviation from the NUPO diet, the form has a date of completion and the dates of the event"
No week,,fase_2_ditetiske_afvigelser,"Anytime through weeks 12-18
This form will register any deviation from the reintroduction of normal meals, the form has a date of completion and the dates of the event"
No week,,fase_3_ditetiske_afvigelser,"Anytime after week 18
This form will register any deviation from the recommended diet, the form has a date of completion and the dates of the event"
No week,,trningsafvigelser,"Anytime after week 18
This form will register any deviation from the recommended exercise, the form has a date of completion and the dates of the event"
No week,,ekstra_kontakt,"Anytime throughout weeks 1-52
This form will capture any contact between study staff and the participant that falls outside the standard touch points. The form as a date for the contact and it is expected that the form is completed on the day of the contact."
No week,,hba1c_follow_up,"Anytime throughout weeks 1-52
This form will register any extra HbA1c testing done at the lab if the study team suspects that there is a problem, the form as a date for the testing"
No week,,medicine_changes,"Anytime throughout weeks 1-52
This form will register any changes to medicine during the study, the form has a date for the capture of the information"
No week,,individual_ditistsamtale_1,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_2,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_3,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_4,At some point between weeks 18 and 50

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think most of them have a date

K-Beicher and others added 4 commits August 6, 2026 10:54
Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
@lwjohnst86 lwjohnst86 changed the title docs: first draft of the relation between weeks and instruments feat: ✨ describe relationship between weeks, visits, and instruments Aug 6, 2026
@lwjohnst86 lwjohnst86 changed the title feat: ✨ describe relationship between weeks, visits, and instruments feat: ✨ describe relationship between weeks, visits, and instruments Aug 6, 2026
@K-Beicher K-Beicher moved this from In Progress to In Review in Data development Aug 6, 2026

@lwjohnst86 lwjohnst86 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice updates ☺️ some more suggested changes


This document explains how the study weeks, visits, and REDCap instruments
relate to each other within the feasibility study. The main study will have
included many of these details into the design of the REDCap.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
included many of these details into the design of the REDCap.
included many of these details into the design of REDCap.

will automatically create a new instance of the instrument for each time it is
set to be used in the Event planning.

| Weeks | Visit | Instrument name |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you add the Phase ID/name as a column too?

will automatically create a new instance of the instrument for each time it is
set to be used in the Event planning.

| Weeks | Visit | Instrument name |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you create another column called like Repetition times or something similar? So that Instrument name directly maps to the actual name. And then move the (1. time) into the "repetition" column (as just a number)?

instruments have a manually entered date field that is used to calculate the
week number.

| Instrument | Description |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you add two new columns start_study_week and end_study_week, so that the week numbers are found in accessible columns rather than as text in a description?

@@ -0,0 +1,88 @@
Study week,Visit,Instrument name,Comments

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please apply the same changes suggested above to here.

Comment on lines +67 to +88
No week,,stamdata,"Running updates throughout weeks 1-52
This form will contain basic information about the participant as well as information about drop-out or completion of study"
No week,,adverse_events,"Anytime throughout weeks 1-52
This form will register any adverse event the participant experience throughout the study, the form has a date of completion and the dates of the event"
No week,,fase_1_ditetiske_afvigelser,"Anytime through weeks 1-11
This form will register any deviation from the NUPO diet, the form has a date of completion and the dates of the event"
No week,,fase_2_ditetiske_afvigelser,"Anytime through weeks 12-18
This form will register any deviation from the reintroduction of normal meals, the form has a date of completion and the dates of the event"
No week,,fase_3_ditetiske_afvigelser,"Anytime after week 18
This form will register any deviation from the recommended diet, the form has a date of completion and the dates of the event"
No week,,trningsafvigelser,"Anytime after week 18
This form will register any deviation from the recommended exercise, the form has a date of completion and the dates of the event"
No week,,ekstra_kontakt,"Anytime throughout weeks 1-52
This form will capture any contact between study staff and the participant that falls outside the standard touch points. The form as a date for the contact and it is expected that the form is completed on the day of the contact."
No week,,hba1c_follow_up,"Anytime throughout weeks 1-52
This form will register any extra HbA1c testing done at the lab if the study team suspects that there is a problem, the form as a date for the testing"
No week,,medicine_changes,"Anytime throughout weeks 1-52
This form will register any changes to medicine during the study, the form has a date for the capture of the information"
No week,,individual_ditistsamtale_1,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_2,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_3,At some point between weeks 18 and 50
No week,,individual_ditistsamtale_4,At some point between weeks 18 and 50

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please split this up into two files, one with the ongoing instruments and another with the scheduled instruments.

@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Data development Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

Write a doc on weeks vs visits vs events

3 participants