Move function to internal #261
Conversation
- h1 - hupdate - gridpts
| @@ -81,39 +81,6 @@ | |||
| #' @importFrom stats qnorm | |||
| #' | |||
| #' @export | |||
| #' | |||
There was a problem hiding this comment.
I am a little concerned that if it is okay to delete the examples of gs_spending_bound, considering it is an exported function,
There was a problem hiding this comment.
Many refer people to the vignettes?
Or we should create examples without h1() function
There was a problem hiding this comment.
If we only show the 1st analysis bound, then we can get rid of h1. Otherwise, if we show the 2nd analysis bound, then we need h1. I personally feel the 2nd analysis is necessary... for the presentation of a comprehensive story.
I am open to referring people to vignettes in @examples, and will defer to @nanxstats for his suggestions.
There was a problem hiding this comment.
Decision: change the examples in gs_spending_bound as we have in gs_design_ahr.
|
@elong0527 @LittleBeannie This brings two great product decisions to make in the team meeting:
They CAN be independent decisions and don't affect the other - because I can tell you a trick to use an internal function without involving the three colons: h1 <- getFromNamespace("h1", ns = "gsDesign2")Although this should only be used sparingly. |
There was a problem hiding this comment.
Hi Yilong, thanks for working on this important PR. I have a discussion with Nan and Keaven this Friday, and we agree that it is okay to keep gridpts, h1 and hupdate un-exported. But we do need @examples for gs_spending_bound, considering it is an exported function.
As Keaven suggested, an example like gs_design_ahr(..., upper = gs_spending_bound, upar = ...) is a good one, because it shows the key usage of gs_spending_bound.
Could you please update the @examples in gs_spending_bound?
| @@ -81,39 +81,6 @@ | |||
| #' @importFrom stats qnorm | |||
| #' | |||
| #' @export | |||
| #' | |||
There was a problem hiding this comment.
Decision: change the examples in gs_spending_bound as we have in gs_design_ahr.
Merge branch 'main' of https://github.com/Merck/gsDesign2 into move-h1 # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
|
Examples are added. |
|
I pushed another commit (4330455) to update the examples in |
Looks good. Thanks! |
#256 move function back to internal
h1hupdategridpts