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

[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 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 this warning.

Thanks!
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

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

[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 
:
 
they still need to be documented, but they're not in the package index.

"Using the internal keyword removes all functions in the associated .Rd 
file from the documentation index and disables some of their automated 
tests. A common use case is to both export a function (using |@export|) 
and marking it as internal. That way, advanced users can access a 
function that new users would be confused about if they were to see it 
in the index."


   Hope that's helpful; if not, feel free to give a little more 
detail/clarify your situation.

On 5/10/20 5:26 PM, 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 functions in an R package.
> Is there any idea to remove this warning.
> Thanks!
> __
> R-package-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel

[[alternative HTML version deleted]]

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

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

[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 functions in an R package.
Is there any idea to remove this warning.


Have you exported the function?

Best,
Uwe Ligges



Thanks!
__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel



__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

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

[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 foo is
excluded from several object indices, including the alphabetical list
of objects in the HTMLhelp system."

Cheers,
Bert

Bert Gunter

"The trouble with having an open mind is that people keep coming along
and sticking things into it."
-- Opus (aka Berkeley Breathed in his "Bloom County" comic strip )

On Sun, May 10, 2020 at 2:31 PM 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 functions in an R package.
> Is there any idea to remove this warning.
>
> Thanks!
> __
> R-package-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel

__
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel