ecl-logo Documentation

Object[Analysis, Clusters]

Automated or manual grouping of point data in tabular form.

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Analysis, Clusters, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Analysis, Clusters]
    Pattern Description: Object[Analysis, Clusters]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

    Author

    The person who ran the analysis.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

General

Data Processing

    NumberOfDimensions

    The number of values defined for each data point.
    Format: Single
    Class: Expression
    Programmatic Pattern: _Integer

    DimensionLabels

    The name of the property described by each value of a data point.
    Format: Single
    Class: Expression
    Programmatic Pattern: ListableP[_String | _Symbol | None]

    DimensionUnits

    The units of measure attached to each value of a data point.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: UnitsP[] | _IndependentUnit

Analysis & Reports

    ClusterLabels

    The name assigned to each group included in ClusteredData.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: _String | _Integer

    ClusterAssignments

    For each member of ClusterLabels, the putative cell identity model associated with that cluster.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
    Relation: Model[Cell]

    PreprocessedData

    The data points after normalization and scaling have been applied.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {} | {{_?NumericQ..}..} | _?(QuantityArrayQ[#1] && Length[Dimensions[#1]] == 2 & )

    IncludedIndices

    The positional indices of all input data points that either lie within the specified Domain or were selected by at least one of the specified ManualGates.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {_?IntegerQ..} | {}

    IncludedData

    The data points that either lie within the specified Domain or were selected by at least one of the specified ManualGates. These values have not been subject to any preprocessing via Normalize or Scale.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {} | {{_?NumericQ..}..} | _?(QuantityArrayQ[#1] && Length[Dimensions[#1]] == 2 & )

    ExcludedIndices

    The positional indices of all input data points that either lie outside the specified Domain, were identified as outliers during automated clustering, or were not selected by any of the specified ManualGates.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {_?IntegerQ..} | {}

    ExcludedData

    The data points that either lie outside of the specified Domain, were identified as outliers during automated clustering, or were not selected by any of the specified ManualGates. These values have not been subject to any preprocessing via Normalize or Scale.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {} | {{_?NumericQ..}..} | _?(QuantityArrayQ[#1] && Length[Dimensions[#1]] == 2 & )

    ClusteredData

    The original data points partitioned into distinct groups. If ClusterDomainOutliers is True, all data points appearing in ExcludedData are also included.
    Format: Single
    Class: Compressed
    Programmatic Pattern: _Association

    ClusteredDataConfidence

    The posterior probability of the group assignment for each data point in ClusteredData.
    Format: Single
    Class: Compressed
    Programmatic Pattern: None | _Association

    WithinClusterSumOfSquares

    The total squared distance from each data point to the mean value of its respective partition.
    Format: Single
    Class: Real
    Programmatic Pattern: GreaterEqualP[0]

    SilhouetteScore

    A clustering evaluation metric that compares the distance between each point and its within-cluster neighbors against the distance between each point and all members of the next-nearest cluster. The metric is bounded between -1 and 1, with larger values reflecting better separability between clusters. For more information, see https://doi.org/10.1016/0377-0427(87)90125-7.
    Format: Single
    Class: Expression
    Programmatic Pattern: None | _?NumericQ

    VarianceRatioCriterion

    A clustering evaluation metric that compares the dispersion between clusters against the dispersion within each cluster. Larger values reflecting better separability between clusters. For more information, see https://doi.org/10.1080/03610927408827101.
    Format: Single
    Class: Expression
    Programmatic Pattern: None | _?NumericQ

    FlowCytometryAnalyses

    The flow cytometry analysis object relating cell counts to this clustering analysis.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
Last modified on Mon 26 Sep 2022 15:43:43