# Tools for Building OLS Regression Models

## Documentation for package ‘olsrr’ version 0.7.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

O P R S

## -- O --

ols_aic | Akaike information criterion
ols_anova | ANOVA
ols_apc | Amemiya's prediction criterion
ols_coll_diag | Collinearity diagnostics
ols_compare_model_performance | Compare model performance
ols_correlations | Part and partial correlations
ols_count_obs | Observations
ols_count_parameters | Parameters count
ols_eigen_cindex | Collinearity diagnostics
ols_fpe | Final prediction error
ols_get_call | Model function call
ols_get_data | Model data
ols_get_deviance | Deviance
ols_get_df | Degrees of freedom
ols_get_formula | Model formula
ols_get_interaction_terms | Interaction terms
ols_get_intercept | Model intercept
ols_get_model_matrix | Model matrix
ols_get_parameters | Model parameters
ols_get_predicted | Fitted values
ols_get_predictors | Predictor variable data
ols_get_residuals | Model residuals
ols_get_response | Response variable data
ols_get_sigma | Sigma
ols_get_variables | Model variables
ols_get_vcov | Variance covariance matrix
ols_hadi | Hadi's influence measure
ols_has_intercept | Model intercept check
ols_hsp | Hocking's Sp
ols_launch_app | Launch shiny app
ols_leverage | Leverage
ols_mallows_cp | Mallow's Cp
ols_model_info | Model object info
ols_model_performance | Model Performance
ols_msep | MSEP
ols_plot_added_variable | Added variable plots
ols_plot_comp_plus_resid | Residual plus component plot
ols_plot_cooksd_bar | Cooks' D bar plot
ols_plot_cooksd_chart | Cooks' D chart
ols_plot_dfbetas | DFBETAs panel
ols_plot_dffits | DFFITS plot
ols_plot_diagnostics | Diagnostics panel
ols_plot_fm | Residual fit spread plot
ols_plot_hadi | Hadi plot
ols_plot_obs_fit | Observed vs fitted values plot
ols_plot_reg_line | Simple linear regression line
ols_plot_resid_box | Residual box plot
ols_plot_resid_fit | Residual vs fitted plot
ols_plot_resid_fit_spread | Residual fit spread plot
ols_plot_resid_hist | Residual histogram
ols_plot_resid_lev | Studentized residuals vs leverage plot
ols_plot_resid_pot | Potential residual plot
ols_plot_resid_qq | Residual QQ plot
ols_plot_resid_regressor | Residual vs regressor plot
ols_plot_resid_spread | Residual fit spread plot
ols_plot_resid_stand | Standardized residual chart
ols_plot_resid_stud | Studentized residual plot
ols_plot_resid_stud_fit | Deleted studentized residual vs fitted values plot
ols_plot_response | Response variable profile
ols_pred_rsq | Predicted rsquare
ols_prep_avplot_data | Added variable plot data
ols_prep_cdplot_data | Cooks' D plot data
ols_prep_cdplot_outliers | Cooks' d outlier data
ols_prep_dfbeta_data | DFBETAs plot data
ols_prep_dfbeta_outliers | DFBETAs plot outliers
ols_prep_dsrvf_data | Deleted studentized residual plot data
ols_prep_outlier_obs | Cooks' D outlier observations
ols_prep_regress_x | Regress predictor on other predictors
ols_prep_regress_y | Regress y on other predictors
ols_prep_rfsplot_fmdata | Residual fit spread plot data
ols_prep_rfsplot_rsdata | Residual fit spread plot data
ols_prep_rstudlev_data | Studentized residual vs leverage plot data
ols_prep_rvsrplot_data | Residual vs regressor plot data
ols_prep_srchart_data | Standardized residual chart data
ols_prep_srplot_data | Studentized residual plot data
ols_press | PRESS
ols_pure_error_anova | Lack of fit F test
ols_regress | Ordinary least squares regression
ols_regress.lm | Ordinary least squares regression
ols_sbc | Bayesian information criterion
ols_sbic | Sawa's bayesian information criterion
ols_step_all_possible | All possible regression
ols_step_all_possible.default | All possible regression
ols_step_all_possible_betas | All possible regression variable coefficients
ols_step_backward_adj_r2 | Stepwise Adjusted R-Squared backward regression
ols_step_backward_adj_r2.default | Stepwise Adjusted R-Squared backward regression
ols_step_backward_aic | Stepwise AIC backward regression
ols_step_backward_aic.default | Stepwise AIC backward regression
ols_step_backward_p | Stepwise backward regression
ols_step_backward_p.default | Stepwise backward regression
ols_step_backward_r2 | Stepwise R-Squared backward regression
ols_step_backward_r2.default | Stepwise R-Squared backward regression
ols_step_backward_sbc | Stepwise SBC backward regression
ols_step_backward_sbc.default | Stepwise SBC backward regression
ols_step_backward_sbic | Stepwise SBIC backward regression
ols_step_backward_sbic.default | Stepwise SBIC backward regression
ols_step_best_subset | Best subsets regression
ols_step_best_subset.default | Best subsets regression
ols_step_both_adj_r2 | Stepwise Adjusted R-Squared regression
ols_step_both_adj_r2.default | Stepwise Adjusted R-Squared regression
ols_step_both_aic | Stepwise AIC regression
ols_step_both_aic.default | Stepwise AIC regression
ols_step_both_p | Stepwise regression
ols_step_both_p.default | Stepwise regression
ols_step_both_r2 | Stepwise R-Squared regression
ols_step_both_r2.default | Stepwise R-Squared regression
ols_step_both_sbc | Stepwise SBC regression
ols_step_both_sbc.default | Stepwise SBC regression
ols_step_both_sbic | Stepwise SBIC regression
ols_step_both_sbic.default | Stepwise SBIC regression
ols_step_forward_adj_r2 | Stepwise Adjusted R-Squared forward regression
ols_step_forward_adj_r2.default | Stepwise Adjusted R-Squared forward regression
ols_step_forward_aic | Stepwise AIC forward regression
ols_step_forward_aic.default | Stepwise AIC forward regression
ols_step_forward_p | Stepwise forward regression
ols_step_forward_p.default | Stepwise forward regression
ols_step_forward_r2 | Stepwise R-Squared forward regression
ols_step_forward_r2.default | Stepwise R-Squared forward regression
ols_step_forward_sbc | Stepwise SBC forward regression
ols_step_forward_sbc.default | Stepwise SBC forward regression
ols_step_forward_sbic | Stepwise SBIC forward regression
ols_step_forward_sbic.default | Stepwise SBIC forward regression
ols_test_bartlett | Bartlett test
ols_test_bartlett.default | Bartlett test
ols_test_breusch_pagan | Breusch pagan test
ols_test_correlation | Correlation test for normality
ols_test_f | F test
ols_test_normality | Test for normality
ols_test_normality.lm | Test for normality
ols_test_outlier | Bonferroni Outlier Test
ols_test_score | Score test
ols_vif_tol | Collinearity diagnostics

## -- P --

plot.ols_step_all_possible | All possible regression
plot.ols_step_backward_adj_r2 | Stepwise Adjusted R-Squared backward regression
plot.ols_step_backward_aic | Stepwise AIC backward regression
plot.ols_step_backward_p | Stepwise backward regression
plot.ols_step_backward_r2 | Stepwise R-Squared backward regression
plot.ols_step_backward_sbc | Stepwise SBC backward regression
plot.ols_step_backward_sbic | Stepwise SBIC backward regression
plot.ols_step_best_subset | Best subsets regression
plot.ols_step_both_adj_r2 | Stepwise Adjusted R-Squared regression
plot.ols_step_both_aic | Stepwise AIC regression
plot.ols_step_both_p | Stepwise regression
plot.ols_step_both_r2 | Stepwise R-Squared regression
plot.ols_step_both_sbc | Stepwise SBC regression
plot.ols_step_both_sbic | Stepwise SBIC regression
plot.ols_step_forward_adj_r2 | Stepwise Adjusted R-Squared forward regression
plot.ols_step_forward_aic | Stepwise AIC forward regression
plot.ols_step_forward_p | Stepwise forward regression
plot.ols_step_forward_r2 | Stepwise R-Squared forward regression
plot.ols_step_forward_sbc | Stepwise SBC forward regression
plot.ols_step_forward_sbic | Stepwise SBIC forward regression

## -- R --

rvsr_plot_shiny | Residual vs regressors plot for shiny app

## -- S --

stepdata | Test Data Set
surgical | Surgical Unit Data Set