Undocumented S4

[stevencarlislewalker]

• [x] generic '*' and siglist 'struc_expanded,struc'
• [x] generic '*' and siglist 'struc_expanded,struc_expanded'
• [x] generic 'dim' and siglist 'struc_expanded'
• [x] generic 'ncol' and siglist 'struc_expanded'
• [x] generic 'nrow' and siglist 'struc_expanded'
• [x] generic '+' and siglist 'struc,struc'
• [x] generic 'resolve' and siglist 'struc_expanded'
• [x] generic '%*%' and siglist 'struc,struc'
• [x] generic '*' and siglist 'struc,struc'
• [x] generic 'colSums' and siglist 'struc'
• [x] generic 'dim' and siglist 'struc'
• [x] generic 'kronecker' and siglist 'struc,struc'
• [x] generic 'ncol' and siglist 'struc'
• [x] generic 'nrow' and siglist 'struc'
• [x] generic 'prod' and siglist 'struc'
• [x] generic 'resolve' and siglist 'struc'
• [x] generic 'rowSums' and siglist 'struc'
• [x] generic 'sum' and siglist 'struc'
• [x] generic 't' and siglist 'struc'

[stevencarlislewalker]

I'm a little frustrated here, because there are some S4 classes that I don't want to export. But it seems impossible to define an S4 class for internal package use only. Perhaps I just need to refactor to not use S4. Or maybe just put in the docs that the associated methods are not for direct use by users.

[stevencarlislewalker]

Handled by documenting non-user facing methods and saying in a note that users should ignore these. Not great ...

[dushoff]

Why is it not great? This must be a solved problem?

On Mon, Aug 29, 2022 at 12:16 PM Steve Walker @.***> wrote:

Handled by documenting non-user facing methods and saying in a note that users should ignore these. Not great ...

— Reply to this email directly, view it on GitHub https://github.com/mac-theobio/McMasterPandemic/issues/193#issuecomment-1230534481, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAW5E6LKE277CA4T23UONVTV3TO67ANCNFSM5RU3GTXA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Jonathan Dushoff (https://tinyurl.com/jd-pronouns) McMaster University Department of Biology https://mac-theobio.github.io/ https://twitter.com/jd_mathbio http://jd-mathbio.blogspot.com/

[stevencarlislewalker]

It is not great because the user needs to see evidence of this struc_expanded class in the documentation, and then be told that it is not for them.

I agree it is likely a solved problem ... I just haven't found anything yet and decided it was time to move on. Definitely open to better solutions.

Maybe @bbolker knows what to do.

[bbolker]

One of the standard ways of sending this signal is to use @keywords internal:

https://blog.r-hub.io/2019/12/12/internal-functions/

The keyword @keywords internal would mean a manual page is created but not present in the function index. A confusing aspect is that you could use it for an exported, not internal function you don’t want to be too visible, e.g. a function returning the default app for OAuth in a package wrapping a web API.

[stevencarlislewalker]

Thanks @bbolker. That did it.