Market Ranking Report (Business Analyst)
Summary
Generates a report to rank data based on a selected variable.
Usage
-
Use this report to determine how well a market will rank based on one or more attributes.
-
You can rank either point data or polygon data.
-
If you summarize sales point data to a market area, you can rank each market based on your sales data to find your best performing markets.
-
The report will rank a given set of features based on a primary rank field.
-
You can use the Ranking Additional Fields option to create a ranking report with two or more attributes.
-
Use the optional Include Average Rank Field option based on the rank order of two or more attributes.
-
The Include Average Rank Field option is a cross-tab rank that weights the rank order based on the count of the variables selected in the report. Use this option when you want to see how all the variables you have chosen in the rank report rank as a whole.
-
Select Use All Features for Ranking if you want to rank all features in the input layer. If you do not check this option in ArcMap, only features that are within the active study area or analysis extent will be ranked.
-
If you want to rank your market and display only the top n number of features, use the Number of Features for Ranking option. For example, you could rank the top 20 performing ZIP Codes in your study area.
Syntax
| Parameter | Explanation | Data Type |
InputFeatureLayer |
The input feature class to be ranked. | Feature Layer |
NameField |
The unique ID of the Rank Markets Layer. | Field |
IDField |
The attribute that will be used to rank the market ranking layer. | Field |
UseSelectedFeaturesOnly (Optional) |
Generates a report on selected features of the market ranking layer.
| Boolean |
UsePercentages (Optional) |
Generates a percentage of the ranking attribute based on another attribute.
| Boolean |
PercentageFieldName (Optional) |
This field is used to calculate a percentage based on the Primary Field to Rank. The percentage is calculated by dividing the Primary Field to Rank by the Field to Percentage | Field |
UseAdditionalFields [[Name, {Alias}, {Add to report}],...] (Optional) |
Additional fields to rank from the market ranking layer. | Value Table |
UseAllInputFeatures (Optional) |
Ranks the features in the market ranking layer.
| Boolean |
NumberOfOutputFeatures (Optional) |
Limits the number of features to rank to the top n features. For example, rank only the top 100 features based on the primary rank field. The default is 1000. | Long |
UseSummOfRank (Optional) |
Creates a new field that sums the rank order of each rank variable.
| Boolean |
IDsOfFeaturesForRanking (Optional) |
Selects the rank field to be filtered by descending values. | File |
CreateReport (Optional) |
Generates an output report.
| Boolean |
ReportTitle (Optional) |
The title for the report. | String |
ReportDir (Optional) |
The output directory that will contain the report. | Folder |
CreateFeatureClass (Optional) |
Outputs the results as a new feature class.
| Boolean |
OutputFeatureClass |
The output feature class containing the new ranked features. | Feature Class |
ReportFormats [ReportFormats,...] (Optional) |
The desired report output format.
| String |
Code Sample
# Name: MarketRankingReport.py
# Description: Ranks total population in the US by CBSA.
# Author: ESRI
# Import system modules
import arcview
import arcpy
arcpy.ImportToolbox("C:\Program Files\ArcGIS\Desktop10.0\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
try:
# Acquire extension license
arcpy.CheckOutExtension("Business")
# Define input and output parameters for the Market Ranking Report tool
MarketRankingLayer = "C:/Program Files/ArcGIS/Desktop10.0/Business Analyst/Data/BDS/esri_cbsa.bds"
ID = "ID"
RankVar = "TOTPOP_CY"
# Create market ranking reports
arcpy.MarketRankingReport_ba(MarketRankingLayer, ID, RankVar)
# Release extension license
arcpy.CheckInExtension("Business")
except:
print arcpy.GetMessages(2)