Ordinary Least Squares (OLS) (Spatial Statistics)—ArcGIS AllSource

Summary

Performs global Ordinary Least Squares (OLS) linear regression to generate predictions or to model a dependent variable in terms of its relationships to a set of explanatory variables.

Note:

The functionality of this tool is included in the Generalized Linear Regression tool added at ArcGIS Pro 2.3. The Generalized Linear Regression tool supports additional models.

Learn more about how Ordinary Least Squares regression works

Illustration

Usage

The primary output for this tool is a report file that is written as messages at the bottom of the Geoprocessing pane during tool execution. You can access the messages by hovering over the progress bar, clicking the pop-out button, or expanding the messages section in the Geoprocessing pane. You can also access the messages for a previous run of Exploratory Regression via the geoprocessing history.
The OLS tool also produces an output feature class and optional tables with coefficient information and diagnostics. All of these are accessible from the messages at the bottom of the Geoprocessing pane . The output feature class is automatically added to the table of contents, with a hot/cold rendering scheme applied to model residuals. A full explanation of each output is provided in How OLS regression works.
Results from OLS regression are only trustworthy if your data and regression model satisfy all of the assumptions inherently required by this method. Consult the Common regression problems, consequences, and solutions table in Regression analysis basics to ensure that your model is properly specified.
Dependent and Explanatory variables should be numeric fields containing a variety of values. OLS cannot solve when variables have the same value (all the values for a field are 9.0, for example). Linear regression methods, such as OLS, are not appropriate for predicting binary outcomes (for example, all of the values for the dependent variable are either 1 or 0).
The Unique ID field links model predictions to each feature. Consequently, the Unique ID values must be unique for every feature, and typically should be a permanent field that remains with the feature class. If you don't have a Unique ID field, you can create one by adding a new integer field to your feature class table and calculating the field values to be equal to the FID/OID field. You cannot use the FID/OID field directly for the Unique ID parameter.
Whenever there is statistically significant spatial autocorrelation of the regression residuals, the OLS model will be considered misspecified. Consequently, results from OLS regression are unreliable. Be sure to run the Spatial Autocorrelation tool on your regression residuals to assess this potential problem. Statistically significant spatial autocorrelation of regression residuals almost always indicates one or more key explanatory variables are missing from the model.
Visually inspect the over- and underpredictions evident in your regression residuals to see if they provide clues about potential missing variables from your regression model. It may help to run Hot Spot Analysis on the residuals to help you visualize spatial clustering of the over- and underpredictions.
When misspecification is the result of trying to model nonstationary variables using a global model (OLS is a global model), Geographically Weighted Regression can be used to improve predictions and to better understand the nonstationarity (regional variation) inherent in your explanatory variables.
When the result of a computation is infinity or undefined, the output for nonshapefiles will be Null; for shapefiles the output will be -DBL_MAX (-1.7976931348623158e+308, for example).
Model summary diagnostics are written to the OLS summary report and the optional diagnostic output table. Both include diagnostics for the corrected Akaike Information Criterion (AICc), Coefficient of Determination, Joint F statistic, Wald statistic, Koenker's Breusch-Pagan statistic, and the Jarque-Bera statistic. The diagnostic table also includes uncorrected AIC and Sigma-squared values.
The optional coefficient and diagnostic output tables, if they already exist, will be overwritten when the Allow geoprocessing tools to overwrite existing datasets option is checked on.
On machines configured with the ArcGIS language packages for Arabic and other right-to-left languages, you might notice missing text or formatting problems in the PDF Output Report File. These problems are addressed in this article.
Map layers can be used to define the Input Feature Class. When using a layer with a selection, only the selected features are included in the analysis.

Caution:

When using shapefiles, keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from nonshapefile inputs may store or interpret null values as zero. In some cases, nulls are stored as very large negative values in shapefiles. This can lead to unexpected results. See Geoprocessing considerations for shapefile output for more information.

Parameters

Label	Explanation	Data Type
Input Feature Class	The feature class containing the dependent and independent variables for analysis.	Feature Layer
Unique ID Field	An integer field containing a different value for every feature in the Input Feature Class.	Field
Output Feature Class	The output feature class that will receive dependent variable estimates and residuals.	Feature Class
Dependent Variable	The numeric field containing values for what you are trying to model.	Field
Explanatory Variables	A list of fields representing explanatory variables in your regression model.	Field
Coefficient Output Table (Optional)	The full path to an optional table that will receive model coefficients, standardized coefficients, standard errors, and probabilities for each explanatory variable.	Table
Diagnostic Output Table (Optional)	The full path to an optional table that will receive model summary diagnostics.	Table
Output Report File (Optional)	The path to the optional PDF file the tool will create. This report file includes model diagnostics, graphs, and notes to help you interpret the OLS results.	File

arcpy.stats.OrdinaryLeastSquares(Input_Feature_Class, Unique_ID_Field, Output_Feature_Class, Dependent_Variable, Explanatory_Variables, {Coefficient_Output_Table}, {Diagnostic_Output_Table}, {Output_Report_File})

Name	Explanation	Data Type
Input_Feature_Class	The feature class containing the dependent and independent variables for analysis.	Feature Layer
Unique_ID_Field	An integer field containing a different value for every feature in the Input Feature Class.	Field
Output_Feature_Class	The output feature class that will receive dependent variable estimates and residuals.	Feature Class
Dependent_Variable	The numeric field containing values for what you are trying to model.	Field
Explanatory_Variables [Explanatory_Variables,...]	A list of fields representing explanatory variables in your regression model.	Field
Coefficient_Output_Table (Optional)	The full path to an optional table that will receive model coefficients, standardized coefficients, standard errors, and probabilities for each explanatory variable.	Table
Diagnostic_Output_Table (Optional)	The full path to an optional table that will receive model summary diagnostics.	Table
Output_Report_File (Optional)	The path to the optional PDF file the tool will create. This report file includes model diagnostics, graphs, and notes to help you interpret the OLS results.	File

Code sample

OrdinaryLeastSquares example 1 (Python window)

The following Python window script demonstrates how to use the OrdinaryLeastSquares function.

import arcpy
arcpy.env.workspace = r"c:\data"
arcpy.stats.OrdinaryLeastSquares("USCounties.shp", "MYID", "olsResults.shp", 
                                 "GROWTH","LOGPCR69;SOUTH;LPCR_SOUTH;PopDen69",
                                 "olsCoefTab.dbf", "olsDiagTab.dbf")

OrdinaryLeastSquares example 2 (stand-alone script)

The following stand-alone Python script demonstrates how to use the OrdinaryLeastSquares function.

# Analyze the growth of regional per capita incomes in US
# Counties from 1969 -- 2002 using Ordinary Least Squares Regression

# Import system modules
import arcpy

# Set property to overwrite existing outputs
arcpy.env.overwriteOutput = True

# Local variables...
workspace = r"C:\Data"

try:
    # Set the current workspace (to avoid having to specify the full path to the feature classes each time)
    arcpy.env.workspace = workspace

    # Growth as a function of {log of starting income, dummy for South
    # counties, interaction term for South counties, population density}
    # Process: Ordinary Least Squares... 
    ols = arcpy.stats.OrdinaryLeastSquares("USCounties.shp", "MYID", 
                        "olsResults.shp", "GROWTH",
                        "LOGPCR69;SOUTH;LPCR_SOUTH;PopDen69",
                        "olsCoefTab.dbf",
                        "olsDiagTab.dbf")

    # Create Spatial Weights Matrix (Can be based on input or output FC)
    # Process: Generate Spatial Weights Matrix... 
    swm = arcpy.stats.GenerateSpatialWeightsMatrix("USCounties.shp", "MYID",
                        "euclidean6Neighs.swm",
                        "K_NEAREST_NEIGHBORS",
                        "#", "#", "#", 6) 
                        
    # Calculate Moran's Index of Spatial Autocorrelation for 
    # OLS Residuals using a SWM File.  
    # Process: Spatial Autocorrelation (Morans I)...      
    moransI = arcpy.stats.SpatialAutocorrelation("olsResults.shp", "Residual",
                        "NO_REPORT", "GET_SPATIAL_WEIGHTS_FROM_FILE", 
                        "EUCLIDEAN_DISTANCE", "NONE", "#", 
                        "euclidean6Neighs.swm")

except:
    # If an error occurred when running the tool, print out the error message.
    print(arcpy.GetMessages())

Environments

Output Coordinate System, Geographic Transformations, Current Workspace, Scratch Workspace, Qualified Field Names, Output has M values, M Resolution, M Tolerance, Output has Z values, Default Output Z Value, Z Resolution, Z Tolerance, XY Resolution, XY Tolerance