easystats / easystats/parameters
Export more `S3` methods for `model_parameters()` generic
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 499
- Forks
- 45
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 3
Description
A lot of the objects listed below are actually supported in parameters, but developers who will be comparing it with broom will think they aren't because there are no exported methods in NAMESPACE.
broom_tidy <- ls(getNamespace("broom"))
broom_tidy <- broom_tidy[grepl("^tidy", broom_tidy)]
broom_supported <- gsub("^tidy.", "", broom_tidy)
easystats_tidy <- ls(getNamespace("parameters"))
easystats_tidy <- easystats_tidy[grepl("^model_parameters", easystats_tidy)]
easystats_supported <- gsub("^model_parameters.", "", easystats_tidy)
broom_supported[!broom_supported %in% easystats_supported]
#> [1] "emmeans" "emmeans_summary"
#> [3] "irlba" "optim"
#> [5] "svd" "xyz"
#> [7] "aareg" "acf"
#> [9] "Arima" "biglm"
#> [11] "binDesign" "binWidth"
#> [13] "boot" "btergm"
#> [15] "cch" "character"
#> [17] "cld" "clm"
#> [19] "confint.glht" "confusionMatrix"
#> [21] "coxph" "crr"
#> [23] "cv.glmnet" "density"
#> [25] "dgCMatrix" "dgTMatrix"
#> [27] "dist" "drc"
#> [29] "durbinWatsonTest" "ergm"
#> [31] "factanal" "felm"
#> [33] "fixest" "ftable"
#> [35] "garch" "geeglm"
#> [37] "glmnet" "glmrob"
#> [39] "glmRob" "gmm"
#> [41] "ivreg" "kappa"
#> [43] "kde" "Kendall"
#> [45] "leveneTest" "Line"
#> [47] "Lines" "lm"
#> [49] "lm.beta" "lmrob"
#> [51] "lmRob" "logical"
#> [53] "lsmobj" "manova"
#> [55] "map" "mfx"
#> [57] "mlogit" "muhaz"
#> [59] "nlrq" "nls"
#> [61] "NULL" "numeric"
#> [63] "orcutt" "plm"
#> [65] "poLCA" "Polygon"
#> [67] "Polygons" "power.htest"
#> [69] "prcomp" "pyears"
#> [71] "rcorr" "ref.grid"
#> [73] "regsubsets" "rlm"
#> [75] "roc" "rq"
#> [77] "sarlm" "Sarlm"
#> [79] "sparseMatrix" "SpatialLinesDataFrame"
#> [81] "SpatialPolygons" "SpatialPolygonsDataFrame"
#> [83] "spec" "speedglm"
#> [85] "speedlm" "summary_emm"
#> [87] "summary.glht" "summary.lm"
#> [89] "summary.plm" "summaryDefault"
#> [91] "survdiff" "survexp"
#> [93] "survfit" "survreg"
#> [95] "svyolr" "table"
#> [97] "tobit" "ts"
#> [99] "TukeyHSD" "zoo"
Created on 2022-07-17 by the reprex package (v2.0.1)
This is because most of them are supported by the default method:
library(parameters)
library(speedglm)
#> Loading required package: Matrix
#> Loading required package: MASS
sloop::s3_dispatch(model_parameters(lm(wt ~ mpg, mtcars)))
#> model_parameters.lm
#> => model_parameters.default
Created on 2022-07-17 by the reprex package (v2.0.1)
I think we just need to do something like-
#' @export
model_parameters.lm <- model_parameters.default
This is low priority, and probably easy enough to be handled by newcomers.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting NAMESPACE and the model_parameters.default entry point. Compare the supported object names in the issue with the package's exported model_parameters methods, then verify that the intended S3 methods are exported rather than relying only on the default method.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100