C# Class Accord.Statistics.Testing.Power.TwoSampleZTestPowerAnalysis

Inheritance: BaseTwoSamplePowerAnalysis

Show file Open project: accord-net/framework Class Usage Examples

Public Methods

Method	Description
ComputeEffect ( ) : void	Computes the minimum detectable effect size for the test considering the power given in IPowerAnalysis.Power, the number of samples in IPowerAnalysis.Samples and the significance level IPowerAnalysis.Size.
ComputePower ( ) : void	Computes the power for a test with givens values of effect size and number of samples under IPowerAnalysis.Size.
ComputeSamples ( double proportion = 1 ) : void	Gets the recommended sample size for the test to attain the power indicating in IPowerAnalysis.Power considering values of IPowerAnalysis.Effect and IPowerAnalysis.Size.
GetEffectSize ( int sampleSize1, int sampleSize2, double power = 0.8, double alpha = 0.05, TwoSampleHypothesis hypothesis = TwoSampleHypothesis.ValuesAreDifferent ) : TwoSampleZTestPowerAnalysis	Estimates the number of samples necessary to attain the required power level for the given effect size.
GetSampleSize ( double delta, double standardDeviation = 1, double proportion = 1.0, double power = 0.8, double alpha = 0.05, TwoSampleHypothesis hypothesis = TwoSampleHypothesis.ValuesAreDifferent ) : TwoSampleZTestPowerAnalysis	Estimates the number of samples necessary to attain the required power level for the given effect size.
TwoSampleZTestPowerAnalysis ( TwoSampleHypothesis hypothesis ) : System	Creates a new ZTestPowerAnalysis.
TwoSampleZTestPowerAnalysis ( TwoSampleZTest test ) : System	Creates a new ZTestPowerAnalysis.

Method Details

ComputeEffect() public method

Computes the minimum detectable effect size for the test considering the power given in IPowerAnalysis.Power, the number of samples in IPowerAnalysis.Samples and the significance level IPowerAnalysis.Size.

public ComputeEffect ( ) : void
return	void

ComputePower() public method

Computes the power for a test with givens values of effect size and number of samples under IPowerAnalysis.Size.

public ComputePower ( ) : void
return	void

ComputeSamples() public method

Gets the recommended sample size for the test to attain the power indicating in IPowerAnalysis.Power considering values of IPowerAnalysis.Effect and IPowerAnalysis.Size.

public ComputeSamples ( double proportion = 1 ) : void
proportion	double
return	void

GetEffectSize() public static method

Estimates the number of samples necessary to attain the required power level for the given effect size.

public static GetEffectSize ( int sampleSize1, int sampleSize2, double power = 0.8, double alpha = 0.05, TwoSampleHypothesis hypothesis = TwoSampleHypothesis.ValuesAreDifferent ) : TwoSampleZTestPowerAnalysis
sampleSize1	int	The number of observations in the first sample.
sampleSize2	int	The number of observations in the second sample.
power	double	The desired power level. Default is 0.8.
alpha	double	The desired significance level. Default is 0.05.
hypothesis	TwoSampleHypothesis	The alternative hypothesis (research hypothesis) to be tested.
return	TwoSampleZTestPowerAnalysis

GetSampleSize() public static method

Estimates the number of samples necessary to attain the required power level for the given effect size.

public static GetSampleSize ( double delta, double standardDeviation = 1, double proportion = 1.0, double power = 0.8, double alpha = 0.05, TwoSampleHypothesis hypothesis = TwoSampleHypothesis.ValuesAreDifferent ) : TwoSampleZTestPowerAnalysis
delta	double	The minimum detectable difference.
standardDeviation	double	The difference standard deviation.
proportion	double	The proportion of observations in the second group /// when compared to the first group. A proportion of 2:1 results in twice more /// samples in the second group than in the first. Default is 1.
power	double	The desired power level. Default is 0.8.
alpha	double	The desired significance level. Default is 0.05.
hypothesis	TwoSampleHypothesis	The alternative hypothesis (research hypothesis) to be tested.
return	TwoSampleZTestPowerAnalysis

TwoSampleZTestPowerAnalysis() public method

Creates a new ZTestPowerAnalysis.

public TwoSampleZTestPowerAnalysis ( TwoSampleHypothesis hypothesis ) : System
hypothesis	TwoSampleHypothesis	The hypothesis tested.
return	System

TwoSampleZTestPowerAnalysis() public method

Creates a new ZTestPowerAnalysis.

public TwoSampleZTestPowerAnalysis ( TwoSampleZTest test ) : System
test	TwoSampleZTest	The test to create the analysis for.
return	System