Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Uwe Ligges
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

Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Duncan Murdoch
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

Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Eggleston, Barry
Thanks everybody. And just to clarify, it is no why that CRAN knew the functions in question were helper functions. From their perspective, I just had a lot of .Rd files with ‘#none’ under @examples. Since these files under question are not directly accessible to the user, I will try the #'

Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Boxuan Cui
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: > > >

Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Zhian Kamvar
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

Re: [R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Joris Meys
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

[R-pkg-devel] Proper way to document helper functions not accessible by user.

2018-08-13 Thread Eggleston, Barry
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 direct user access, but it has many helper