Merge pull request #148 from MangiolaLaboratory/add_test_messaging

add message
MangiolaLaboratory · Aug 28, 2024 · 71f2e1a · 71f2e1a
2 parents f0f8314 + 8f54a93
commit 71f2e1a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/R/methods.R b/R/methods.R
@@ -438,6 +438,11 @@ sccomp_estimate.data.frame = function(.data,
       pass_fit = pass_fit
     )
 
+  message("sccomp says: to do hypothesis testing run `sccomp_test()`, 
+  the `test_composition_above_logit_fold_change` = 0.1 equates to a change of ~10%, and 
+  0.7 equates to ~100% increase, if the baseline is ~0.1 proportion. 
+  Use `sccomp_proportional_fold_change` to convert c_effect (linear) to proportion difference (non linear).")
+
   res  |> 
 
     # Track input parameters