On 13.08.2018 16:51, Duncan Murdoch wrote:
On 13/08/2018 9:08 AM, Eggleston, Barry wrote:
Hello,
I am working through my first submission and making good progress with
the CRAN review system, but now I need to understand the best practice
for dealing with helper functions. I am building a
On 13/08/2018 9:08 AM, Eggleston, Barry wrote:
Hello,
I am working through my first submission and making good progress with the CRAN
review system, but now I need to understand the best practice for dealing with
helper functions. I am building a package that only exports 12 functions for
di
#' @noRd
option that Zhian Kamvar mentions in my resubmission.
Thanks,
Barry
From: Boxuan Cui
Sent: Monday, August 13, 2018 9:32 AM
To: Eggleston, Barry
Cc: r-package-devel@r-project.org
Subject: Re: [R-pkg-devel] Proper way to document helper functions not
accessible by user.
Do you ha
Do you have to export them? If not, I think you can just leave out the
@export from the roxygen2 comments.
Here is what I did for my package:
https://github.com/boxuancui/DataExplorer/blob/master/R/helper.r
Best,
Boxuan (Bo)
On Mon, Aug 13, 2018 at 2:08 PM Eggleston, Barry wrote:
>
> > Hello,
You can add
#' @noRd
to those functions and roxygen2 will not generate .Rd files for those
entries.
On Mon, Aug 13, 2018 at 2:08 PM Eggleston, Barry wrote:
> Hello,
>
> I am working through my first submission and making good progress with the
> CRAN review system, but now I need to understand
Hi Barry,
could you specify wh osked you to provide examples? R CHECK doesn't give me
any warnings. If it was asked by the people of CRAN itself, you can explain
that these are internal functions and the help pages are only there for
reference to advanced users. But I'm not sure if they'll accept
