=================================================================== RCS file: /home/cvs/OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v retrieving revision 1.7 retrieving revision 1.15 diff -u -p -r1.7 -r1.15 --- OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2015/03/21 22:49:34 1.7 +++ OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2016/03/01 07:29:18 1.15 @@ -1,4 +1,4 @@ -% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.6 2014/03/24 05:28:17 takayama Exp $ +% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.14 2016/02/16 02:17:00 takayama Exp $ \name{hgm.pwishart} \alias{hgm.pwishart} %- Also NEED an '\alias' for EACH other topic documented here. @@ -11,7 +11,8 @@ 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,autoplot) } %- maybe also 'usage' for other objects documented here. \arguments{ @@ -32,6 +33,8 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{dp}{ Sampling interval of solutions by the Runge-Kutta method. + When autoplot=1 or dp is negative, it is automatically set. + if it is 0, no sample is stored. } \item{q}{ The second value y[0] of this function is the Prob(L1 < q) @@ -39,9 +42,10 @@ 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. - When mode=c(1,1,(m^2+1)*p), intermediate values of P(L1 < x) with respect to + of the matrix hypergeometric series and its derivatives at q0. + When mode=c(1,1,(2^m+1)*p), intermediate values of P(L1 < x) with respect to p-steps of x are also returned. Sampling interval is controled by dp. + When autoplot=1, it is automatically set. } \item{method}{ a-rk4 is the default value. @@ -50,8 +54,9 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{err}{ When err=c(e1,e2), e1 is the absolute error and e2 is the relative error. - As long as NaN is not returned, it is recommended to set to - err=c(0.0, 1e-10), because initial values are usually very small. + This parameter controls the adative Runge-Kutta method. + If the output is absurd, you may get a correct answer by setting, e.g., + err=c(1e-(xy+5), 1e-10) or by increasing q0 when initial value at q0 is very small as 1e-xy. } \item{automatic}{ automatic=1 is the default value. @@ -70,14 +75,26 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, If it is 1, then steps of automatic degree updates and several parameters are output to stdout and stderr. } + \item{autoplot}{ + autoplot=0 is the default value. + If it is 1, then this function outputs an input for plot + (which is equivalent to setting the 3rd argument of the mode parameter properly). + When ans is the output, ans[1,] is c(q,prob at q,...), ans[2,] is c(q0,prob at q0,...), and ans[3,] is c(q0+q/100,prob at q/100,...), ... + When the adaptive Runge-Kutta method is used, the step size h may change + automatically, + which makes the sampling period change, in other words, the sampling points + q0+q/100, q0+2*q/100, q0+3*q/100, ... may change. + In this case, the output matrix may contain zero rows in the tail or overfull. + In case of the overful, use the mode option to get the all result. + } } \details{ 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}}. } @@ -108,9 +125,9 @@ 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. @@ -121,6 +138,11 @@ hgm.pwishart(m=3,n=5,beta=c(1,2,3),q=10) ## ===================================================== b<-hgm.pwishart(m=4,n=10,beta=c(1,2,3,4),q0=1,q=10,approxdeg=20,mode=c(1,1,(16+1)*100)); c<-matrix(b,ncol=16+1,byrow=1); +#plot(c) +## ===================================================== +## Example 3. +## ===================================================== +c<-hgm.pwishart(m=4,n=10,beta=c(1,2,3,4),q0=1,q=10,approxdeg=20,autoplot=1); #plot(c) } % Add one or more standard keywords, see file 'KEYWORDS' in the