Class VariableStatistic

Represents summary statistics and frequencies for data described by a logical Variable.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
VariableStatistic
Implements
Inherited Members
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class VariableStatistic : VersionableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IVisitable

Constructors

VariableStatistic()

Initializes a new instance of the VariableStatistic class.

Declaration
public VariableStatistic()

Properties

DisplayLabel

Displays the Variable name, or Variable name and weighted variable name

Declaration
public override string DisplayLabel { get; }
Property Value
Type Description
string
Overrides

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
bool

true if this instance has any category statistics; otherwise, false.

Invalid

Gets or sets the number of invalid or missing values in the data.

Declaration
public double? Invalid { get; set; }
Property Value
Type Description
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
double?

The kurtosis.

Maximum

Gets or sets the maximum value found in the data.

Declaration
public double? Maximum { get; set; }
Property Value
Type Description
double?

The maximum.

Mean

Gets or sets the mean value of the data.

Declaration
public double? Mean { get; set; }
Property Value
Type Description
double?

The mean.

Minimum

Gets or sets the minimum value found in the data.

Declaration
public double? Minimum { get; set; }
Property Value
Type Description
double?

The minimum.

Skewness

Gets or sets the skewness.

Declaration
public double? Skewness { get; set; }
Property Value
Type Description
double?

The skewness.

StandardDeviation

Gets or sets the standard deviation.

Declaration
public double? StandardDeviation { get; set; }
Property Value
Type Description
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
long?

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
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
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
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

HasSameStatistics(VariableStatistic)

Determines if the statistics contained within two VariableStatistics are the same.

Declaration
public bool HasSameStatistics(VariableStatistic statistic)
Parameters
Type Name Description
VariableStatistic statistic

The other VariableStatistic to compare against.
Returns
Type Description
bool

A bool indicating if the statistics are equal.

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
int

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
int

The number of children replaced.
Overrides
Exceptions
Type Condition
ArgumentNullException

child

Set(SummaryStatisticType, double, bool)

Sets the specified statistic.

Declaration
public void Set(SummaryStatisticType statType, double value, bool isWeighted = false)
Parameters
Type Name Description
SummaryStatisticType statType

The type of statistic to set.
double value

The value of the statistic.
bool isWeighted

Set if the value is weighted.

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides

Implements

Extension Methods