From m@rt@@k@r@@@ @ending from gm@il@com  Mon Dec 17 04:51:35 2018
From: m@rt@@k@r@@@ @ending from gm@il@com (=?UTF-8?B?TWFydGEgS2FyYcWb?=)
Date: Sun, 16 Dec 2018 22:51:35 -0500
Subject: [Rd] Function I mean not to export keeps being documented in a
 manual?
Message-ID: <CADVZz_pG=Pu4-FdtqF3vhYAgF7=7MML6qpCrX7WQBGtkvg1rrw@mail.gmail.com>

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]]



[Rd] Function I mean not to export keeps being documented in a manual?
=?UTF-8?B?TWFydGEgS2FyYcWb?=