Record Class MissingnessIndicatorAdder.Result

java.lang.Object
java.lang.Record
edu.cmu.tetrad.search.utils.MissingnessIndicatorAdder.Result
Record Components:
data - The augmented dataset, with knowledge attached if the spec asked for it.
indicatorNames - The names of the indicators added, in column order.
rates - The missingness rate of every variable in the input, in column order.
skipped - Human-readable reasons for variables that did not get an indicator.
Enclosing class:
MissingnessIndicatorAdder

public static record MissingnessIndicatorAdder.Result(DataSet data, List<String> indicatorNames, Map<String,Double> rates, List<String> skipped) extends Record
The augmented dataset together with a record of what was done, for logging and for the session box to display.
Author:
josephramsey
  • Constructor Details

    • Result

      public Result(DataSet data, List<String> indicatorNames, Map<String,Double> rates, List<String> skipped)
      Creates an instance of a Result record class.
      Parameters:
      data - the value for the data record component
      indicatorNames - the value for the indicatorNames record component
      rates - the value for the rates record component
      skipped - the value for the skipped record component
  • Method Details

    • summary

      public String summary()
      Returns a short summary suitable for a log entry.
      Returns:
      the summary.
    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • data

      public DataSet data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component
    • indicatorNames

      public List<String> indicatorNames()
      Returns the value of the indicatorNames record component.
      Returns:
      the value of the indicatorNames record component
    • rates

      public Map<String,Double> rates()
      Returns the value of the rates record component.
      Returns:
      the value of the rates record component
    • skipped

      public List<String> skipped()
      Returns the value of the skipped record component.
      Returns:
      the value of the skipped record component