Skip to content

Update error handling and documentation for harm bound #672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jdblischak wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update error handling and documentation for harm bound #672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 1 addition & 33 deletions R/gs_design_npe.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,39 +271,7 @@ gs_design_npe <- function(
# for a fixed design, this is all you need.
if (n_analysis == 1) {
if (any(test_harm)) {
ans_h1 <- gs_power_npe(
theta = theta, theta0 = theta0, theta1 = theta1,
info = info * min_x, info0 = info0 * min_x, info1 = info1 * min_x,
info_scale = info_scale,
upper = gs_b, upar = qnorm(1 - alpha), test_upper = test_upper,
lower = if (two_sided) lower else gs_b,
lpar = if (two_sided) lpar else rep(-Inf, n_analysis),
test_lower = test_lower, binding = binding,
harm = harm, hpar = hpar, test_harm = test_harm,
r = r, tol = tol
)
ans_h0 <- gs_power_npe(
theta = 0, theta0 = theta0, theta1 = theta1,
info = info0 * min_x, info0 = info0 * min_x, info1 = info1 * min_x,
info_scale = info_scale,
upper = gs_b, upar = qnorm(1 - alpha), test_upper = test_upper,
lower = if (two_sided) lower else gs_b,
lpar = if (two_sided) lpar else rep(-Inf, n_analysis),
test_lower = test_lower, binding = binding,
harm = harm, hpar = hpar, test_harm = test_harm,
r = r, tol = tol
)
suppressMessages(
ans <- ans_h1 |>
full_join(
ans_h0 |>
select(analysis, bound, probability) |>
rename(probability0 = probability)
)
)
ans <- ans |> select(analysis, bound, z, probability, probability0, theta, info_frac, info, info0, info1)
class(ans) <- c("gs_design_npe", class(ans))
return(ans)
stop("gs_design_npe() harm bound cannot be tested if there is only one analysis.")
}

ans <- tibble(
Expand Down
8 changes: 4 additions & 4 deletions R/gs_power_npe.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@
#' a logical vector of the same length as `info` should
#' indicate which analyses will have a lower bound.
#' @param test_harm Indicator of which analyses should include a harm bound;
#' single value of `TRUE` (default) indicates all analyses;
#' single value of `FALSE` indicates no harm bound; otherwise,
#' single value of `FALSE` (default) indicates no harm bound;
#' single value of `TRUE` indicates all analyses; otherwise,
#' a logical vector of the same length as `info` should
#' indicate which analyses will have a harm bound.
#' For fixed designs, the harm bound is typically not included.
#' For group sequential designs, the harm bound is always smaller than the lower bound (if any).
#' For fixed designs, requesting a harm bound fails immediately with an error.
#' @param r Integer value controlling grid for numerical integration as in
#' Jennison and Turnbull (2000); default is 18, range is 1 to 80.
#' Larger values provide larger number of grid points and greater accuracy.
Expand Down Expand Up @@ -295,7 +295,7 @@ gs_power_npe <- function(theta = .1, theta0 = 0, theta1 = theta, # 3 theta
) {
# Check & set up parameters ----
n_analysis <- length(info)
if (n_analysis == 1 && test_harm) {
if (n_analysis == 1 && any(test_harm)) {
stop("gs_power_npe() harm bound cannot be tested if there is only one analysis.")
}

Expand Down
8 changes: 4 additions & 4 deletions man/gs_design_ahr.Rd
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions man/gs_power_ahr.Rd
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions man/gs_power_design_npe.Rd
View file
Open in desktop

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

3 changes: 2 additions & 1 deletion tests/testit/test-developer-gs_design_npe.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,8 @@ assert("Harm bound is not provided for fixed designs", {
theta = 0.1, info = 40,
upper = gs_b, upar = -qnorm(0.025), test_upper = TRUE,
lower = gs_b, lpar = -Inf, test_lower = FALSE,
harm = gs_b, hpar = -2, test_harm = TRUE)
harm = gs_b, hpar = -2, test_harm = TRUE),
"gs_design_npe() harm bound cannot be tested if there is only one analysis."
))
})

Expand Down
9 changes: 8 additions & 1 deletion tests/testit/test-developer-gs_power_npe.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,14 @@ assert("Harm bound is not provided for fixed designs", {
theta = 0.1, info = 40,
upper = gs_b, upar = -qnorm(0.025), test_upper = TRUE,
lower = gs_b, lpar = -Inf, test_lower = FALSE,
harm = gs_b, hpar = -2, test_harm = TRUE)
harm = gs_b, hpar = -2, test_harm = TRUE),
"gs_power_npe() harm bound cannot be tested if there is only one analysis."
))

# Throw informative error even if test_harm is not length 1
(has_error(
gs_power_npe(test_harm = c(FALSE, TRUE)),
"gs_power_npe() harm bound cannot be tested if there is only one analysis."
))
})

Expand Down