Class VariableStatistic
Represents summary statistics and frequencies for data described by a logical Variable.
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class VariableStatistic : VersionableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IVisitable, IHasCustomFields
Constructors
VariableStatistic()
Initializes a new instance of the VariableStatistic class.
Declaration
public VariableStatistic()
Properties
FilteredCategoryStatistics
Gets a collection of categorical statistics that may be calculated for a subset of the data represented by the variable.
Declaration
public ObservableCollection<CategoryStatistics> FilteredCategoryStatistics { get; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<CategoryStatistics> |
HasCategoryStatistics
Gets a value indicating whether this instance has any category statistics.
Declaration
public bool HasCategoryStatistics { get; }
Property Value
| Type | Description |
|---|---|
| Boolean |
|
Invalid
Gets or sets the number of invalid or missing values in the data.
Declaration
public double? Invalid { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The number of invalid or missing values. |
ItemType
Gets the universally unique identifier representing the item's type.
Declaration
public override Guid ItemType { get; }
Property Value
| Type | Description |
|---|---|
| Guid | The identifier representing the item's type. |
Overrides
Kurtosis
Gets or sets the kurtosis.
Declaration
public double? Kurtosis { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The kurtosis. |
Maximum
Gets or sets the maximum value found in the data.
Declaration
public double? Maximum { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The maximum. |
Mean
Gets or sets the mean value of the data.
Declaration
public double? Mean { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The mean. |
Minimum
Gets or sets the minimum value found in the data.
Declaration
public double? Minimum { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The minimum. |
Skewness
Gets or sets the skewness.
Declaration
public double? Skewness { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The skewness. |
StandardDeviation
Gets or sets the standard deviation.
Declaration
public double? StandardDeviation { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The standard deviation. |
SummaryStatistics
Gets a collection of summary statistics describing the variable.
Declaration
public Collection<SummaryStatistic> SummaryStatistics { get; set; }
Property Value
| Type | Description |
|---|---|
| Collection<SummaryStatistic> |
TotalResponses
Gets or sets the total responses.
Declaration
public long? TotalResponses { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Int64> |
UnfilteredCategoryStatistics
Gets a collection of categorical statistics that apply to all categories.
Declaration
public ObservableCollection<CategoryStatistics> UnfilteredCategoryStatistics { get; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<CategoryStatistics> |
Valid
Gets or sets the number of valid values in the data.
Declaration
public double? Valid { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The number valid values. |
VariableReference
Gets or sets the logical variable that describes the data being summarized.
Declaration
public Variable VariableReference { get; set; }
Property Value
| Type | Description |
|---|---|
| Variable |
Variance
Gets or sets the variance.
Declaration
public double? Variance { get; set; }
Property Value
| Type | Description |
|---|---|
| Nullable<Double> | The variance. |
WeightVariable
Gets or sets the variable used to weight the variable being summarized.
Declaration
public Variable WeightVariable { get; set; }
Property Value
| Type | Description |
|---|---|
| Variable |
Methods
Get(SummaryStatisticType)
Gets the value of the specified statistic.
Declaration
public double? Get(SummaryStatisticType statType)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryStatisticType | statType | The type of statistic to retrieve. |
Returns
| Type | Description |
|---|---|
| Nullable<Double> | The value of the specified statistic. |
GetChildren()
Gets the identifiers of the item's children.
Declaration
public override ChildItemCollection GetChildren()
Returns
| Type | Description |
|---|---|
| ChildItemCollection | The identifiers of the item's children. |
Overrides
Remove(SummaryStatisticType)
Removes the specified type of statistic.
Declaration
public void Remove(SummaryStatisticType statType)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryStatisticType | statType | The type of statistic. |
RemoveChild(IdentifierTriple)
Removes the specified child.
Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | child | The child to be removed. |
Returns
| Type | Description |
|---|---|
| Int32 | The number of children removed from the item. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |
ReplaceChild(IdentifierTriple, IVersionable)
Replaces the child with the specified identifier with the provided item.
Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
| Type | Name | Description |
|---|---|---|
| IdentifierTriple | toReplace | The identifier of the child to replace. |
| IVersionable | child | The new child. |
Returns
| Type | Description |
|---|---|
| Int32 | The number of children replaced. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | child |
Set(SummaryStatisticType, Double)
Sets the specified statistic.
Declaration
public void Set(SummaryStatisticType statType, double value)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryStatisticType | statType | The type of statistic to set. |
| Double | value | The value of the statistic. |