This outlines how to propose a change to ggeffects.
Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file. If you want to fix typos in the documentation, please edit the related .R
file in the R/
folder. Do not edit an .Rd
file in man/
.
The easiest way to propose a change or new feature is to file an issue. If you’ve found a bug, you may also create an associated issue. If possible, try to illustrate your proposal or the bug with a minimal reproducible example.
The package is easily extendable, to add support for other model objects. The only requirement is that following methods are available: predict()
, model.frame()
and family()
. If model objects do not support these methods, you may implement workarounds (see below).
Following code needs to be revised to add further model objects:
get_model_function()
needs a line to specify whether the new model can be considered as linear or generalized linear model.get_predict_function()
needs a line to specify the class.select_prediction_method()
to call the right prediction-method, and add a method get_predictions_<class>()
, if one of the existing prediction-methods does not fit the needs of the new model object.When the model object does not support one of predict()
, model.frame()
or family()
, you may add workarounds:
family()
-function, a workaround has to be added to model_family()
in the sjstats-package.model.frame()
-function with standard arguments or return values, a workaround has to be added to model_frame()
in the sjstats-package.predict()
-function, a workaround has to be added to get_predictions_<class>()
in the file predictions.R (in this package).Most likely, there’s no need to add more functions to this package. It’s main purpose is to calculate predicted values, so ggpredict()
and ggeffect()
should cover the main functionality of this package.
NEWS.md
describing the changes made. You may optionally add your GitHub username, and links to relevant issue(s)/PR(s).Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.