GetFeatureAssociationMatrix {datarobot}

Get pairwise feature association statistics for a project's informative features

Description

Get pairwise feature association statistics for a project's informative features

Usage

GetFeatureAssociationMatrix(project, associationType, metric)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

associationType

character. The type of association, must be either "association" or "correlation".

metric

character. The specified association metric, must be one of "mutualInfo", "cramersV", "spearman", "pearson", or "tau".

Value

A list with two items:

• features data.frame. A data.frame containing the following info for each feature:

  • alphabeticSortIndex integer. A number representing the alphabetical order of this feature compared to the other features in this dataset.

  • feature character. The name of the feature.

  • importanceSortIndex integer. A number ranking the importance of this feature compared to the other features in this dataset.

  • strengthSortIndex integer. A number ranking the strength of this feature compared to the other features in this dataset.

• strengths data.frame. A data.frame of pairwise strength data, with the following info:

  • feature1 character. The name of the first feature.

  • feature2 character. The name of the second feature.

  • statistic numeric. Feature association statistics for 'feature1' and 'feature2'.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  GetFeatureAssociationMatrix(projectId)

## End(Not run)