Package ubic.gemma.model.expression.experiment

Enum BatchEffectType

java.lang.Object
java.lang.Enum<BatchEffectType>
ubic.gemma.model.expression.experiment.BatchEffectType
All Implemented Interfaces:
Serializable, Comparable<BatchEffectType>
public enum BatchEffectType extends Enum<BatchEffectType>
Represents a batch effect.
Author:
poirigui

  • Enum Constant Details

    • NO_BATCH_INFO

      public static final BatchEffectType NO_BATCH_INFO
      Indicate that there is no batch information available.

    • SINGLETON_BATCHES_FAILURE

      public static final BatchEffectType SINGLETON_BATCHES_FAILURE
      Batch contains singleton (i.e. batch with a single experiment) thus preventing any variance estimate.

    • UNINFORMATIVE_HEADERS_FAILURE

      public static final BatchEffectType UNINFORMATIVE_HEADERS_FAILURE
      Batch information is uninformative.

    • PROBLEMATIC_BATCH_INFO_FAILURE

      public static final BatchEffectType PROBLEMATIC_BATCH_INFO_FAILURE
      Batch information is problematic.

    • BATCH_EFFECT_FAILURE

      public static final BatchEffectType BATCH_EFFECT_FAILURE
      Indicate that there is a batch effect. It might be correctable.

    • BATCH_CORRECTED_SUCCESS

      public static final BatchEffectType BATCH_CORRECTED_SUCCESS
      Indicate that there was a significant batch effect that was corrected.

    • SINGLE_BATCH_SUCCESS

      public static final BatchEffectType SINGLE_BATCH_SUCCESS
      Indicate that there is a single batch and thus there cannot be a batch effect.

    • BATCH_EFFECT_UNDETERMINED_FAILURE

      public static final BatchEffectType BATCH_EFFECT_UNDETERMINED_FAILURE
      Indicate that all information necessary is present, but the batch effect could not be determined.

      This can result from a failure to perform SVD or to find a suitable batch factor in the experimental design.

    • NO_BATCH_EFFECT_SUCCESS

      public static final BatchEffectType NO_BATCH_EFFECT_SUCCESS
      Indicate that there is no batch effect. Yay!

  • Method Details

    • values

      public static BatchEffectType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static BatchEffectType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null