Closed HenrikBengtsson closed 9 months ago
Not at this point. I added #' @keywords internal
to both glm2table()
and gam2table()
Got it. So, in recent versions of R (I think >= 4.3.0), R CMD check
now checks all man/ pages, which I think required ditto functions to be exported. I created PR #56 that adds #' @noRd
to this function to fix the check warning that you otherwise gets.
Should I add #' @noRd
to all #' @keywords internal
functions?
I guess that's rOpenSci's recommendation (https://devguide.ropensci.org/building.html)
Before reading roxygen's docs, I thought #' @keywords internal
would stop docs from being rendered, instead of just excluding from documentation index.
Should I add
#' @noRd
to all#' @keywords internal
functions?
I'm pretty sure it's only needed for non-exported functions. Note that #' @keywords internal
has nothing to do with a function being exported or not; it just declares that the function/object should not be listed in the HTML help index.
R CMD check
reports on:While looking at this, I noticed that
rtemis:::gam2table()
is documented by not exported;https://github.com/egenn/rtemis/blob/31cd8eb57e0a8f0d715b7beedd190bb0910193f5/R/glm2table.R#L1-L20
Should it be exported?
FWIW, it looks like
R CMD check
picks up anothergam2table
from one of the dependencies.