=================================================================== RCS file: /home/cvs/OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v retrieving revision 1.6 retrieving revision 1.11 diff -u -p -r1.6 -r1.11 --- OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2014/03/24 05:28:17 1.6 +++ OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2016/02/13 22:56:50 1.11 @@ -1,17 +1,18 @@ -% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.5 2014/03/16 03:11:07 takayama Exp $ +% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.10 2015/03/27 02:36:30 takayama Exp $ \name{hgm.pwishart} \alias{hgm.pwishart} %- Also NEED an '\alias' for EACH other topic documented here. \title{ The function hgm.pwishart evaluates the cumulative distribution function - of random wishart matrix. + of random wishart matrices. } \description{ The function hgm.pwishart evaluates the cumulative distribution function - of random wishart matrix of size m times m. + of random wishart matrices of size m times m. } \usage{ -hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method,err) +hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, + err,automatic,assigned_series_error,verbose) } %- maybe also 'usage' for other objects documented here. \arguments{ @@ -39,7 +40,7 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{mode}{ When mode=c(1,0,0), it returns the evaluation - of the matrix hypergeometric series and its derivatives at x0. + of the matrix hypergeometric series and its derivatives at q0. When mode=c(1,1,(m^2+1)*p), intermediate values of P(L1 < x) with respect to p-steps of x are also returned. Sampling interval is controled by dp. } @@ -75,9 +76,9 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, It is evaluated by the Koev-Edelman algorithm when x is near the origin and by the HGM when x is far from the origin. We can obtain more accurate result when the variables h is smaller, - x0 is relevant value (not very big, not very small), + q0 is relevant value (not very big, not very small), and the approxdeg is more larger. - A heuristic method to set parameters x0, h, approxdeg properly + A heuristic method to set parameters q0, h, approxdeg properly is to make x larger and to check if the y[0] approaches to 1. % \code{\link[RCurl]{postForm}}. } @@ -97,14 +98,20 @@ Journal of Multivariate Analysis, 117, (2013) 296-312, Nobuki Takayama } \note{ -%% ~~further notes~~ +This function does not work well under the following cases: +1. The beta (the set of eigenvalues) +is degenerated or is almost degenerated. +2. The beta is very skew, in other words, there is a big eigenvalue +and there is also a small eigenvalue. +The error control is done by a heuristic method. +The obtained value is not validated automatically. } %% ~Make other sections like Warning with \section{Warning }{....} ~ -\seealso{ -%%\code{\link{oxm.matrix_r2tfb}} -} +%\seealso{ +%%%\code{\link{oxm.matrix_r2tfb}} +%} \examples{ ## ===================================================== ## Example 1.