Re: [R-pkg-devel] Documentation for non-user-level objects

2020-05-11 Thread Maëlle SALMON via R-package-devel
I see you already got useful answers, but here is a further resource: I wrote a blog post about internal functions earlier this year Best wishes Maëlle. Den söndag 10 maj 2020 23:32:00 CEST, Sapphire Zhou skrev: I met a problem wh

Re: [R-pkg-devel] Documentation for non-user-level objects

2020-05-11 Thread Ben Bolker
   If you've exported them then they are "user-level objects". You can either remove them from the list of exported objects (edit your NAMESPACE or change your roxygen specifications), or document them somewhere.  One standard solution is  to use the "internal" keyword

Re: [R-pkg-devel] Documentation for non-user-level objects

2020-05-10 Thread Uwe Ligges
On 10.05.2020 23:26, Sapphire Zhou wrote: I met a problem when I uploaded the package to CRAN. There is a warning told me “All user-level objects in a package should have documentation entries.” Actually, those functions are not user-level functions. How could I claim non-user-level function

Re: [R-pkg-devel] Documentation for non-user-level objects

2020-05-10 Thread Bert Gunter
1. Don't export them. 2. Use: \keyword{ internal } in the .Rd file >From "Writing R Extensions" "The special keyword ‘internal’ marks a page of internal objects that are not part of the package’s API. If the help page for object foo has keyword ‘internal’, then help(foo) gives this help page, but

[R-pkg-devel] Documentation for non-user-level objects

2020-05-10 Thread Sapphire Zhou
I met a problem when I uploaded the package to CRAN. There is a warning told me “All user-level objects in a package should have documentation entries.” Actually, those functions are not user-level functions. How could I claim non-user-level functions in an R package. Is there any idea to remove