update grammar in param_notes

- changes are consistent with those requested in #82
metrumresearchgroup · Feb 11, 2025 · d2e8c63 · d2e8c63
1 parent 0b608b0
commit d2e8c63
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/R/param-notes.R b/R/param-notes.R
@@ -44,16 +44,16 @@ param_notes <- function(.ci = 95, .zscore = NULL){
   alpha <- signif((1 - (.ci / 100)), 3)
 
   list(
-    ci   = "CI: confidence intervals",
+    ci   = "CI: confidence interval",
     corr = "Corr: correlation coefficient",
     cv   = "CV: coefficient of variation",
     rse = "RSE: relative standard error",
     se   = "SE: standard error",
     sd   = "SD: standard deviation",
     ciEq =  paste0("CI = estimate $\\pm$ $\\mathcal{Z}_{\\alpha/2}$ $\\cdot$ SE, $\\alpha = ", alpha, "$"),
-    cvOmegaEq = "CV\\% of log-normal omegas = sqrt(exp(estimate) - 1) $\\cdot$ 100",
+    cvOmegaEq = "CV\\% of log-normal omega = sqrt(exp(estimate) - 1) $\\cdot$ 100",
     cvSigmaEq = "CV\\% of sigma = sqrt(estimate) $\\cdot$ 100",
-    logTrans = "Parameters estimated in the log-domain were back-transformed for clarity",
-    logitTrans = "Parameters estimated in the logit-domain were back-transformed for clarity"
+    logTrans = "Parameters estimated in the log domain were back-transformed for clarity",
+    logitTrans = "Parameters estimated in the logit domain were back-transformed for clarity"
   )
 }
diff --git a/tests/testthat/test-param-notes.R b/tests/testthat/test-param-notes.R
@@ -20,5 +20,5 @@ test_that("param_notes expected output: footnotes",{
   eq4 <- param_notes()
   expect_equal(11, length(eq4))
   expect_equal(anyNA(eq4), FALSE)
-  expect_equal(eq4$cvOmegaEq,"CV\\% of log-normal omegas = sqrt(exp(estimate) - 1) $\\cdot$ 100")
+  expect_equal(eq4$cvOmegaEq,"CV\\% of log-normal omega = sqrt(exp(estimate) - 1) $\\cdot$ 100")
 })