WeibullAnalysisResults Class - Revision history

Kate Racaza at 20:24, 24 June 2016

2016-06-24T20:24:45Z

← Older revision		Revision as of 20:24, 24 June 2016
Line 2:		Line 2:


	<onlyinclude>Represents ~~additional results~~ from the life data analysis of an associated [[WeibullDataSet Class\|WeibullDataSet]] object.</onlyinclude>		<onlyinclude>Represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis of the associated [[WeibullDataSet Class\|WeibullDataSet]] object.</onlyinclude>

	== Properties ==		== Properties ==

Kate Racaza at 15:27, 14 April 2016

2016-04-14T15:27:09Z

← Older revision		Revision as of 15:27, 14 April 2016
Line 7:		Line 7:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\| style="width: 180px;"\|CorrelationCoefficient\|\|Gets the correlation coefficient (rho value) if the parameters were estimated using rank regression. '''Double'''.		\| style="width: 180px;"\|CorrelationCoefficient\|\|Gets the correlation coefficient (rho value), assuming the parameters of the distribution were estimated using rank regression. '''Double'''.
	\|-		\|-
	\|LikelihoodValue\|\|Gets the likelihood function value (LK value). '''Double'''.		\|LikelihoodValue\|\|Gets the likelihood function value (LK value). '''Double'''.
	\|-		\|-
	\|PercentNonZero\|\|Gets the percent non-zero (Pnz) value if the data set ~~contains failure at ''t'' = 0~~. '''Double'''. A value of 1 indicates that there are no zero failure times in the data set; a decimal value indicates that the data set includes zero failure times.		\|PercentNonZero\|\|Gets the percent non-zero (Pnz) value of the data set. '''Double'''. A value of 1 indicates that there are no zero failure times in the data set; a decimal value indicates that the data set includes zero failure times.
	\|}		\|}

Kate Racaza at 21:59, 13 April 2016

2016-04-13T21:59:07Z

← Older revision		Revision as of 21:59, 13 April 2016
Line 16:		Line 16:

	== Example ==		== Example ==
			The following example demonstrates how to return the correlation coefficient of a particular WeibullDataSet object.

	'''VBA'''		'''VBA'''

	{{APIComment\|'Declare a WeibullDataSet.}}		{{APIComment\|'Declare a WeibullDataSet object.}}
	{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet		{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet

Line 37:		Line 38:
	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'Declare a WeibullDataSet.}}		{{APIComment\|'Declare a WeibullDataSet object.}}
	{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet		{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet

Kate Racaza at 21:53, 13 April 2016

2016-04-13T21:53:11Z

← Older revision		Revision as of 21:53, 13 April 2016
Line 17:		Line 17:
	== Example ==		== Example ==

	VBA		'''VBA'''

	{{APIComment\|'Declare a WeibullDataSet.}}		{{APIComment\|'Declare a WeibullDataSet.}}
Line 35:		Line 35:
	Msgbox(CorrCoeff)		Msgbox(CorrCoeff)

	VB.NET		'''VB.NET'''

	{{APIComment\|'Declare a WeibullDataSet.}}		{{APIComment\|'Declare a WeibullDataSet.}}

Kate Racaza at 21:50, 13 April 2016

2016-04-13T21:50:11Z

← Older revision		Revision as of 21:50, 13 April 2016
Line 2:		Line 2:


	<onlyinclude>Represents ~~the~~ additional results from the life data analysis ~~(e.g., correlation coefficient, likelihood ratio, etc.)~~.</onlyinclude>		<onlyinclude>Represents additional results from the life data analysis of an associated [[WeibullDataSet Class\|WeibullDataSet]] object.</onlyinclude>

	== Properties ==		== Properties ==
Line 52:		Line 52:
	CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient		CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
	Msgbox(CorrCoeff)		Msgbox(CorrCoeff)

	~~==See Also==~~
	*[[WeibullDataSet Class]]

Kate Racaza at 21:46, 13 April 2016

2016-04-13T21:46:41Z

← Older revision		Revision as of 21:46, 13 April 2016
Line 1:		Line 1:
	{{Template:~~APIClass\|WeibullDataSet_Class\|WeibullDataSet~~}}		{{Template:API}}{{Template:APIBreadcrumb}}
	~~Stores the correlation coefficient, likelihood value and percent non-zero values that were estimated from the analysis, if applicable.~~

	~~These are equivalent to the "Rho," "LK Value" and "Pnz" results that can be shown in the Analysis Summary of the standard folio control panel.~~

	~~== Properties==~~		<onlyinclude>Represents the additional results from the life data analysis (e.g., correlation coefficient, likelihood ratio, etc.).</onlyinclude>

	*CorrelationCoefficient (as ''~~double~~''~~) {{APIComment~~\|~~{{Template:WeibullAnalysisResults.CorrelationCoefficient.Cmt}}}}~~		== Properties ==
	*LikelihoodValue (as ''~~double~~''~~) {{APIComment~~\|~~{{Template:WeibullAnalysisResults.LikelihoodValue.Cmt}}}}~~		{\| {{APITable}}
	*PercentNonZero (as ''~~double~~''~~) {{APIComment\|{{Template:WeibullAnalysisResults~~.~~PercentNonZero~~.~~Cmt}}}~~}		\|-
			\| style="width: 180px;"\|CorrelationCoefficient\|\|Gets the correlation coefficient (rho value) if the parameters were estimated using rank regression. '''Double'''.
			\|-
			\|LikelihoodValue\|\|Gets the likelihood function value (LK value). '''Double'''.
			\|-
			\|PercentNonZero\|\|Gets the percent non-zero (Pnz) value if the data set contains failure at ''t'' = 0. '''Double'''. A value of 1 indicates that there are no zero failure times in the data set; a decimal value indicates that the data set includes zero failure times.
			\|}

	~~== Usage Example ==~~

	{{APIComment\|'Declare ~~the~~ WeibullDataSet. ~~See [[~~WeibullDataSet ~~Class~~\|WeibullDataSet]].}}		== Example ==
	Dim WDS as New WeibullDataSet
			VBA

			{{APIComment\|'Declare a WeibullDataSet.}}
			{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet

			{{APIComment\|'Add the failure times 10, 20 and 30 to the data set.}}
			{{APIPrefix\|Call}} WDS.AddFailure(10, 1)
			{{APIPrefix\|Call}} WDS.AddFailure(20, 1)
			{{APIPrefix\|Call}} WDS.AddFailure(30, 1)

			{{APIComment\|'Fit the data to a life distribution, using all default settings.}}
			WDS.Calculate

			{{APIComment\|'Retrieve the value of the correlation coefficient.}}
			{{APIPrefix\|Dim}} CorrCoeff {{APIPrefix\|As}} Double
			CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
			Msgbox(CorrCoeff)

			VB.NET

			{{APIComment\|'Declare a WeibullDataSet.}}
			{{APIPrefix\|Dim}} WDS {{APIPrefix\|as New}} WeibullDataSet

	{{APIComment\|'Add ~~three~~ failure times to the ~~raw~~ data~~. See [[WeibullDataSet.AddFailure\|AddFailure]]~~.}}		{{APIComment\|'Add the failure times 10, 20 and 30 to the data set.}}
	WDS.AddFailure(1, 1)		WDS.AddFailure(10, 1)
	WDS.AddFailure(2, 1)		WDS.AddFailure(20, 1)
	WDS.AddFailure(3, 1)		WDS.AddFailure(30, 1)

	{{APIComment\|'Fit the data to a life distribution, using all default settings~~. See [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]]~~.}}		{{APIComment\|'Fit the data to a life distribution, using all default settings.}}
	WDS.Calculate		WDS.Calculate

	{{APIComment\|'Retrieve the ~~results. In this example,~~ the correlation coefficient ~~result value is retrieved~~.}}		{{APIComment\|'Retrieve the value of the correlation coefficient.}}
	Dim CorrCoeff As Double		{{APIPrefix\|Dim}} CorrCoeff {{APIPrefix\|As}} Double
	CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient		CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient
			Msgbox(CorrCoeff)

			==See Also==
			*[[WeibullDataSet Class]]

Chris Kahn: /* Formatted Usage Example */

2014-04-28T15:47:08Z

Formatted Usage Example

← Older revision		Revision as of 15:47, 28 April 2014
Line 10:		Line 10:
	*PercentNonZero (as ''double'') {{APIComment\|{{Template:WeibullAnalysisResults.PercentNonZero.Cmt}}}}		*PercentNonZero (as ''double'') {{APIComment\|{{Template:WeibullAnalysisResults.PercentNonZero.Cmt}}}}

	== ~~Formatted~~ Usage Example ==		== Usage Example ==

	{{APIComment\|'Declare the WeibullDataSet. See [[WeibullDataSet Class\|WeibullDataSet]].}}		{{APIComment\|'Declare the WeibullDataSet. See [[WeibullDataSet Class\|WeibullDataSet]].}}

Chris Kahn: /* Formatted Usage Example */

2014-04-28T15:46:48Z

Formatted Usage Example

← Older revision		Revision as of 15:46, 28 April 2014
Line 12:		Line 12:
	== Formatted Usage Example ==		== Formatted Usage Example ==

	{{APIComment\|'Declare the WeibullDataSet. See [[~~New~~ WeibullDataSet]] ~~for additional details~~.}}		{{APIComment\|'Declare the WeibullDataSet. See [[WeibullDataSet Class\|WeibullDataSet]].}}
	Dim WDS as New WeibullDataSet		Dim WDS as New WeibullDataSet

	{{APIComment\|'Add ~~values~~ to the raw data. See [[WeibullDataSet.AddFailure\|AddFailure]] ~~for additional details~~.}}		{{APIComment\|'Add three failure times to the raw data. See [[WeibullDataSet.AddFailure\|AddFailure]].}}
	WDS.AddFailure(1, 1)		WDS.AddFailure(1, 1)
	WDS.AddFailure(2, 1)		WDS.AddFailure(2, 1)
	WDS.AddFailure(3, 1)		WDS.AddFailure(3, 1)

	{{APIComment\|'~~Calculate~~ the ~~WeibullDataSet~~. See [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] ~~for additional details~~.}}		{{APIComment\|'Fit the data to a life distribution, using all default settings. See [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]].}}
	WDS.Calculate		WDS.Calculate

Chris Kahn at 22:15, 25 April 2014

2014-04-25T22:15:46Z

← Older revision		Revision as of 22:15, 25 April 2014
Line 12:		Line 12:
	== Formatted Usage Example ==		== Formatted Usage Example ==

	{{APIComment\|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}		{{APIComment\|'Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
	Dim WDS as New WeibullDataSet		Dim WDS as New WeibullDataSet

	{{APIComment\|Add values to the raw data. See [[WeibullDataSet.AddFailure\|AddFailure]] for additional details.}}		{{APIComment\|'Add values to the raw data. See [[WeibullDataSet.AddFailure\|AddFailure]] for additional details.}}
	WDS.AddFailure(1, 1)		WDS.AddFailure(1, 1)
	WDS.AddFailure(2, 1)		WDS.AddFailure(2, 1)
	WDS.AddFailure(3, 1)		WDS.AddFailure(3, 1)

	{{APIComment\|Calculate the WeibullDataSet. See [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] for additional details.}}		{{APIComment\|'Calculate the WeibullDataSet. See [[WeibullDataSet.CalculateBestFit\|CalculateBestFit]] for additional details.}}
	WDS.Calculate		WDS.Calculate

	{{APIComment\|Retrieve the results. In this example, the correlation coefficient result value is retrieved.}}		{{APIComment\|'Retrieve the results. In this example, the correlation coefficient result value is retrieved.}}
	Dim CorrCoeff As Double		Dim CorrCoeff As Double
	CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient		CorrCoeff = WDS.AnalysisResults.CorrelationCoefficient

Chris Kahn at 21:06, 21 February 2014

2014-02-21T21:06:18Z

← Older revision		Revision as of 21:06, 21 February 2014
Line 1:		Line 1:
	{{Template:APIClass\|WeibullDataSet_Class\|WeibullDataSet}}		{{Template:APIClass\|WeibullDataSet_Class\|WeibullDataSet}}
	~~Gets~~ the correlation coefficient, likelihood value and percent non-zero values that were estimated from the analysis, if applicable.		Stores the correlation coefficient, likelihood value and percent non-zero values that were estimated from the analysis, if applicable.

	These are equivalent to the "Rho," "LK Value" and "Pnz" results that can be shown in the Analysis Summary of the standard folio control panel.		These are equivalent to the "Rho," "LK Value" and "Pnz" results that can be shown in the Analysis Summary of the standard folio control panel.