Skip to content

Commit

Permalink
update some help info
Browse files Browse the repository at this point in the history
  • Loading branch information
qinyun-lin committed May 21, 2024
1 parent 1ce8e2b commit 88a4087
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion R/pkonfound.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#' @param sdx the standard deviation of X
#' @param sdy the standard deviation of Y
#' @param R2 the unadjusted,original R2 in the observed function
#' @param far_bound whether the estimated effect is moved to the boundary closer (default 0) to further away (1);
#' @param far_bound whether the estimated effect is moved to the boundary closer (default 0) or further away (1);
#' @param eff_thr for RIR: unstandardized coefficient threshold to change an inference; for IT: correlation defining the threshold for inference
#' @param FR2max the largest R2, or R2max, in the final model with unobserved confounder
#' @param FR2max_multiplier the multiplier of R2 to get R2max, default is set to 1.3
Expand Down
2 changes: 1 addition & 1 deletion R/test_sensitivity.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ test_sensitivity <- function(est_eff,
tested_variable) {

## warning messages for potential confusion
if (far_bound == 1) warning("far_bound is defined by a threshold of opposite sign of the estimated effect.")
if (far_bound == 1) warning("far_bound is defined by whether the estimated effect is moved to the boundary closer(0) or further away(1).")

if (!is.na(eff_thr) & nu != 0) {
nu <- 0
Expand Down
2 changes: 1 addition & 1 deletion man/pkonfound.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 88a4087

Please sign in to comment.