Why functions in helper_function.R are exported?

[elong0527]

Could we review if it is necessary to export helper functions？

https://merck.github.io/gsDesign2/reference/index.html#low-level-helpers

[nanxstats]

Sure, it might be productive to prioritize functions that are not currently used anywhere in code examples and vignettes, as it would require non-trivial changes to the code examples and vignette to un-export previously exported functions.

Or do you mean we need one (or multiple) more accurate file name(s) + section name(s) to organize these functions instead of simply using the generic term "helper"?

[elong0527]

Feel those functions should not be exported to user.

For example, why would a user need h1 function.

[nanxstats]

Sure, that makes sense. My point was, h1() is used in gs_spending_bound() examples in both function documentation and vignettes:

https://merck.github.io/gsDesign2/articles/usage-gs-spending-bound.html
https://merck.github.io/gsDesign2/reference/gs_spending_bound.html

So they need to be rewritten or removed to un-export h1().

[elong0527]

Got it. If that's the only reason to keep them exported. Let me find way to rewrite them.

btw, would you feel vignettes is OK to refer internal function if we did not submit the vignettes to CRAN? (Given some vignettes is to discuss internal logic derivation for technical details)

[nanxstats]

Got it. If that's the only reason to keep them exported. Let me find way to rewrite them.

btw, would you feel vignettes is OK to refer internal function if we did not submit the vignettes to CRAN? (Given some vignettes is to discuss internal logic derivation for technical details)

Sounds great.

And good point - it might be ok to use ::: in the (article) vignettes because vignettes/articles/ are not even built into the tarball when running R CMD build. So the strict rules from R CMD check will likely not apply to those Rmd files.

[LittleBeannie]

Decision: we will keep the following functions exported:
gs_power_npe()
gs_design_npe()
expected_accrual()
ppwe()
s2pwe()

And we can un-export the following functions:
gridpts()
h1()
hupdate()
gs_create_arm()
related PR: #261

[LittleBeannie]

Let's work on this issue when #261 is merged.

[fb-elong]

Please review the diff, examples has been udpated.