Dear R community, I wrote and someone else helped me type a 5-page R-info in Chinese, covering the most basic information on how to get and install and start using R on Wintel PC. This could serve those not fluent in/intimidated by English but want to start using R. (I met a lot of those in China) <http://www.ms.uky.edu/~mai/ZhongWen.htm> also a MSword version of the same (may print better). <http://www.ms.uky.edu/~mai/ZhongWen.doc> Now I have a question: I am packaging several functions doing empirical likelihood ratio as an R package. Using R CMD check emplik, There is warning about undocumented functions. Those are "utility functions" used by the main function. What do I suppose to do for those functions? where do I document them? I do not think they warrant a full document like the regular function. Thanks! Mai Zhou -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html Send "info", "help", or "[un]subscribe" (in the "body", not the subject !) To: r-help-request at stat.math.ethz.ch _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
On Fri, 9 Nov 2001, Mai Zhou wrote:> Now I have a question: I am packaging several functions doing > empirical likelihood ratio as an R package. > > Using R CMD check emplik, > There is warning about undocumented functions. > > Those are "utility functions" used by the main function. > What do I suppose to do for those functions? where do I document them? > > I do not think they warrant a full document like the regular function.The solution (in 'Writing R Extension' section 1.1.3 for version 1.3.1) is to have a single 'internals' page for each package that lists all these functions. For an example, do library(ts) help("ts-internal") This confirms that you haven't just forgotten to document these functions. -thomas Thomas Lumley Asst. Professor, Biostatistics tlumley at u.washington.edu University of Washington, Seattle -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html Send "info", "help", or "[un]subscribe" (in the "body", not the subject !) To: r-help-request at stat.math.ethz.ch _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
On Fri, 9 Nov 2001, Mai Zhou wrote:> Dear R community, > > I wrote and someone else helped me type a 5-page R-info in Chinese, > covering the most basic information on how to get and install > and start using R on Wintel PC. > > This could serve those not fluent in/intimidated by > English but want to start using R. > (I met a lot of those in China) > > <http://www.ms.uky.edu/~mai/ZhongWen.htm> > > also a MSword version of the same (may print better). > > <http://www.ms.uky.edu/~mai/ZhongWen.doc> > > > Now I have a question: I am packaging several functions doing > empirical likelihood ratio as an R package. > > Using R CMD check emplik, > There is warning about undocumented functions. > > Those are "utility functions" used by the main function. > What do I suppose to do for those functions? where do I document them? > > I do not think they warrant a full document like the regular function.Right, but this is described in `Writing R Extensions'. To see the style, see e.g. ts-internal.Rd. Brian -- Brian D. Ripley, ripley at stats.ox.ac.uk Professor of Applied Statistics, http://www.stats.ox.ac.uk/~ripley/ University of Oxford, Tel: +44 1865 272861 (self) 1 South Parks Road, +44 1865 272860 (secr) Oxford OX1 3TG, UK Fax: +44 1865 272595 -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html Send "info", "help", or "[un]subscribe" (in the "body", not the subject !) To: r-help-request at stat.math.ethz.ch _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
This is excellent! I've been thinking of writing one like that myself for quite a while. Would you mind if I translate it into Traditional (Big-5) Chinese and add more stuff to it? And does anyone out there know if there are any tutorials/documentations using traditional Chinese? BTW, have you thought of using LaTeX to write the documentation ;-)? Ko-Kang Wang -----Original Message----- From: owner-r-help at stat.math.ethz.ch [mailto:owner-r-help at stat.math.ethz.ch]On Behalf Of Mai Zhou Sent: Saturday, November 10, 2001 6:00 AM To: r-help at stat.math.ethz.ch Subject: [R] A chinese R-info page and a question Dear R community, I wrote and someone else helped me type a 5-page R-info in Chinese, covering the most basic information on how to get and install and start using R on Wintel PC. This could serve those not fluent in/intimidated by English but want to start using R. (I met a lot of those in China) <http://www.ms.uky.edu/~mai/ZhongWen.htm> also a MSword version of the same (may print better). <http://www.ms.uky.edu/~mai/ZhongWen.doc> -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html Send "info", "help", or "[un]subscribe" (in the "body", not the subject !) To: r-help-request at stat.math.ethz.ch _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._