Skip to content

Conversation

sschildhauer
Copy link
Collaborator

For this pull request I am specifying the documentation for the run_mod data input. Here we are listing the different columns necessary for run_mod, including: id_var, biomarker_var, timeindays, and value_var. I am also including as_case_data as a reference for specifying these variables as attributes.

Copy link

codecov bot commented Jul 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Files with missing lines Coverage Δ
R/Run_Mod.R 100.00% <ø> (ø)

Copy link

github-actions bot commented Jul 5, 2025

📖 https://ucd-serg.github.io/serodynamics/preview/pr105
Preview documentation for this PR (at commit 80fae15)

@sschildhauer sschildhauer requested a review from Kwan-Jenny July 5, 2025 03:46
@sschildhauer sschildhauer linked an issue Jul 5, 2025 that may be closed by this pull request
Comment on lines +17 to +21
#' - id_var = The ID of individuals included
#' - biomarker_var = The different antigen isotype combinations that are being
#' measured
#' - timeindays = The amount of time in days since symptom onset
#' - value_var = The measured assay value
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
#' - id_var = The ID of individuals included
#' - biomarker_var = The different antigen isotype combinations that are being
#' measured
#' - timeindays = The amount of time in days since symptom onset
#' - value_var = The measured assay value
#' - id_var = Unique identifier for each individual.
#' - biomarker_var = Antigen-isotype combinations being measured (e.g., "~ IgG").
#' - timeindays = Time since symptom onset, in days.
#' - value_var = Measured assay value (e.g., MFI-bg, OD, or concentration).

Copy link
Collaborator

Choose a reason for hiding this comment

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

@sschildhauer I just left a suggestion for a possible change. You don't need to update it—it's just an example in case you find it helpful.

Copy link
Collaborator

@Kwan-Jenny Kwan-Jenny left a comment

Choose a reason for hiding this comment

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

Everything looks clean and well structured. I left a minor suggestion for clarity, but no changes are necessary unless you prefer it.

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

Successfully merging this pull request may close these issues.

issues with run_mod() documentation
2 participants