Record Class MissingnessThreshold.Candidate

java.lang.Object
java.lang.Record
edu.cmu.tetrad.data.missing.MissingnessThreshold.Candidate
Record Components:
name - The variable's name.
missingRate - Its missingness rate.
maxAbsCorrelation - The largest absolute pairwise correlation between this variable and any variable the threshold would retain, computed on their pairwise-complete cases; NaN when no pair has enough overlap to compute one. High values are the warning: this variable carries information about the retained system, so removing it may confound what is left.
maxCorrelatedWith - The retained variable achieving that correlation, or null when none.
pairwiseN - The pairwise-complete count behind that correlation, or 0 when none.
Enclosing class:
MissingnessThreshold
public static record MissingnessThreshold.Candidate(String name, double missingRate, double maxAbsCorrelation, String maxCorrelatedWith, int pairwiseN) extends Record
A variable that a threshold would drop, with what is needed to judge whether dropping it is safe.
Author:
josephramsey

  • Constructor Details

    • Candidate

      public Candidate(String name, double missingRate, double maxAbsCorrelation, String maxCorrelatedWith, int pairwiseN)
      Creates an instance of a Candidate record class.
      Parameters:
      name - the value for the name record component
      missingRate - the value for the missingRate record component
      maxAbsCorrelation - the value for the maxAbsCorrelation record component
      maxCorrelatedWith - the value for the maxCorrelatedWith record component
      pairwiseN - the value for the pairwiseN record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • missingRate

      public double missingRate()
      Returns the value of the missingRate record component.
      Returns:
      the value of the missingRate record component

    • maxAbsCorrelation

      public double maxAbsCorrelation()
      Returns the value of the maxAbsCorrelation record component.
      Returns:
      the value of the maxAbsCorrelation record component

    • maxCorrelatedWith

      public String maxCorrelatedWith()
      Returns the value of the maxCorrelatedWith record component.
      Returns:
      the value of the maxCorrelatedWith record component

    • pairwiseN

      public int pairwiseN()
      Returns the value of the pairwiseN record component.
      Returns:
      the value of the pairwiseN record component