[Roxygen-commits] r198 - pkg/inst/doc

[noreply at r-forge.r-project.org]

Author: pcd
Date: 2008-08-27 20:39:23 +0200 (Wed, 27 Aug 2008)
New Revision: 198

Modified:
   pkg/inst/doc/roxygen.Rnw
   pkg/inst/doc/roxygen.bib
Log:
R CMD roxygen


Modified: pkg/inst/doc/roxygen.Rnw
===================================================================
--- pkg/inst/doc/roxygen.Rnw	2008-08-27 17:58:51 UTC (rev 197)
+++ pkg/inst/doc/roxygen.Rnw	2008-08-27 18:39:23 UTC (rev 198)
@@ -152,9 +152,11 @@
 
 \subsection{Running \Roxygen{}}
 
-TODO: talk about \texttt{R CMD roxygen} vs. \texttt{roxygenize}.
+Running \texttt{`R CMD roxygen -d pseudoprime'} populates \texttt{man}
+with Rd files, edits \texttt{DESCRIPTION} and \texttt{NAMESPACE}, and
+puts call graphs in \texttt{inst/doc}:
 
-<<>>=
+<<echo=false>>=
 roxygenize('pseudoprime',
            roxygen.dir='pseudoprime',
            copy.package=FALSE,
@@ -162,6 +164,9 @@
 
 @ 
 
+The \texttt{roxygenize} function is an alternative to \texttt{`R CMD
+  roxygen'}; see the help page for details.
+
 \bibliographystyle{plainnat}
 \bibliography{roxygen}
 \end{document}

Modified: pkg/inst/doc/roxygen.bib
===================================================================
--- pkg/inst/doc/roxygen.bib	2008-08-27 17:58:51 UTC (rev 197)
+++ pkg/inst/doc/roxygen.bib	2008-08-27 18:39:23 UTC (rev 198)
@@ -1,13 +1,25 @@
 @Manual{r-core,
   title =        {Writing R Extensions},
   OPTkey =       {},
-  author =    {{R Development Core Team}},
+  author =       {{R Development Core Team}},
   organization = {R Foundation for Statistical Computing},
-  address =   {Vienna, Austria},
+  address =      {Vienna, Austria},
   OPTedition =   {},
   OPTmonth =     {},
-  year =      {2008},
+  year =         {2008},
   OPTnote =      {},
   OPTannote =    {}
 }
 
+ at Manual{danenberg,
+  title =        {Roxygen Manual},
+  OPTkey =       {},
+  author =       {Peter Danenberg},
+  OPTorganization = {},
+  OPTaddress =   {},
+  OPTedition =   {},
+  OPTmonth =     {},
+  OPTyear =      {},
+  OPTnote =      {},
+  OPTannote =    {}
+}