Automate available tidiers list

[nutterb]

I'm not sure if this README.md file is where you want this, but I put in a README.Rmd file that grabs all of the classes broom can tidy, glance, and augment and sticks them in a table. It's a big table though, and maybe it would be better to stick this in a folder ignored by the build process. Then you could link to it from the main README.

This addresses Issue #66

[dgrtwo]

Great idea!

I ended up moving the whole Available Tidiers section down the page a bit, since from a marketing perspective it might distract people who still don't know what the package does :).

[briatte]

I'm not sure how the list is generated, but it has a row for NULL models, and does not list glm, for instance.

Question: how do you want to handle aliased methods?

Example: the mgcv package can estimate both gam and bam objects. As far as I can tell, the latter are just the former, but with large datasets. The results of both models are similar and should be amenable to the same tidy and glance methods.

Is it sufficient to add tidy.bam <- tidy.gam to the code and to alias the gam_tidiers documentation page with bam_tidiers?

[nutterb]

The list is generated by making a data frame from methods("tidy"), methods("glance") and methods("augment"). glm is missing because I used left_join when I should have used full_join. I'll fix this when I get home tonight. Thanks for pointing my attention to that.

Believe it or not, there is a tidy.NULL method, which is why it shows up in the list. (https://github.com/dgrtwo/broom/blob/master/R/tidy.R).

For tidy.bam, it will show up in the list as long as there is a method for bam objects, even if it is as simple as

tidy.bam <- function(...){
  tidy.gam(...)
}

[briatte]

Thanks for the explanation about the README.

Aliasing is important for the project. Another example: the AER package has an ivreg function that can be tidied exactly like lm.

[github-actions]

This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.