Entering edit mode
Hi! I have noticed that my Bioconductor package manual contains functions with #' @keywords internal in their roxygen documentation. I would prefer those not to get into the manual pdf as I believe they are unneccessarily confusing the users. Did I do something wrong in the set-up? How to fix it? Thanks!
I did. What there should have answered my question? Thanks!
The part that says
If you do
You won't see any of your internal functions. But they are accessible from
?, and will therefore be part of the manual, since it covers all the accessible help functions.Thank you! I didn't know that manual covers all accessible help functions. How can I overwrite this?
Remove the 'internal' keyword. I generally only have Roxygen entries for functions that I mean to document. If you don't want those functions to be in the manual, then why do you want them to be accessible using the
?function? Put a different way, if these are internal functions that aren't meant to be called by the end user, why document them at all?I didn't know it's allowed! For some reason I thought functions must be documented. Also it's useful for myself, even if the documentation is very short. Got it, thank you!
No internal functions need to be documented. I get wanting to have documentation for yourself so you can remember what it's for. You'll always have your GitHub site, so you can just remove the \internal and the documentation will stay, without being published. You have to go there (or your local git dir) to see the documentation, but I doubt you will need to do so on the regular, so it's probably fine.