Function I mean not to export keeps being documented in a manual?

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Function I mean not to export keeps being documented in a manual?

martakarass
I am developing an R package which has a function I decided not to export.
I believe the roxygen information states that the function is not going to
be exported, yet I still see the function in the manual PDF (as generated
in command line via `CMD Rd2pdf package_dir`). What is wrong with my
preamble that the function is still being documented in a manual?

#' Generates plots for demo of package functions which take time series and
#' window width parameters
#'
#' @param func runstats package core function
#' @param plt.title.vec vector of function-specific plot titles
#'
#' @importFrom grDevices rgb
#' @importFrom graphics abline lines par plot points polygon title
#'
#' @return \code{NULL}
#'
#' @examples
#' \dontrun{
#' func <- RunningMean
#' vec <- c("black: x\nred: W-width running window",
#'          "RunningMean(x, W)",
#'          "RunningMean(x, W, circular = TRUE)")
#' plot.no.pattern(func, vec)
#' }
#'
#'
plot.no.pattern <- function(func, plt.title.vec){
...
}

Bests / Pozdrawiam,
Marta Karas

        [[alternative HTML version deleted]]

______________________________________________
[hidden email] mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Reply | Threaded
Open this post in threaded view
|

Re: Function I mean not to export keeps being documented in a manual?

R devel mailing list
Dear Marta,

Add the @noRd tag to the Roxygen documentation of the function.

Best regards,

ir. Thierry Onkelinx
Statisticus / Statistician

Vlaamse Overheid / Government of Flanders
INSTITUUT VOOR NATUUR- EN BOSONDERZOEK / RESEARCH INSTITUTE FOR NATURE AND
FOREST
Team Biometrie & Kwaliteitszorg / Team Biometrics & Quality Assurance
[hidden email]
Havenlaan 88 bus 73, 1000 Brussel
www.inbo.be

///////////////////////////////////////////////////////////////////////////////////////////
To call in the statistician after the experiment is done may be no more
than asking him to perform a post-mortem examination: he may be able to say
what the experiment died of. ~ Sir Ronald Aylmer Fisher
The plural of anecdote is not data. ~ Roger Brinner
The combination of some data and an aching desire for an answer does not
ensure that a reasonable answer can be extracted from a given body of data.
~ John Tukey
///////////////////////////////////////////////////////////////////////////////////////////

<https://www.inbo.be>


Op ma 17 dec. 2018 om 08:57 schreef Marta Karaƛ <[hidden email]>:

> I am developing an R package which has a function I decided not to export.
> I believe the roxygen information states that the function is not going to
> be exported, yet I still see the function in the manual PDF (as generated
> in command line via `CMD Rd2pdf package_dir`). What is wrong with my
> preamble that the function is still being documented in a manual?
>
> #' Generates plots for demo of package functions which take time series and
> #' window width parameters
> #'
> #' @param func runstats package core function
> #' @param plt.title.vec vector of function-specific plot titles
> #'
> #' @importFrom grDevices rgb
> #' @importFrom graphics abline lines par plot points polygon title
> #'
> #' @return \code{NULL}
> #'
> #' @examples
> #' \dontrun{
> #' func <- RunningMean
> #' vec <- c("black: x\nred: W-width running window",
> #'          "RunningMean(x, W)",
> #'          "RunningMean(x, W, circular = TRUE)")
> #' plot.no.pattern(func, vec)
> #' }
> #'
> #'
> plot.no.pattern <- function(func, plt.title.vec){
> ...
> }
>
> Bests / Pozdrawiam,
> Marta Karas
>
>         [[alternative HTML version deleted]]
>
> ______________________________________________
> [hidden email] mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

        [[alternative HTML version deleted]]

______________________________________________
[hidden email] mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel