[Roxygen-commits] r185 - in pkg: R inst/doc man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Aug 25 15:09:37 CEST 2008
Author: pcd
Date: 2008-08-25 15:09:37 +0200 (Mon, 25 Aug 2008)
New Revision: 185
Added:
pkg/inst/doc/index.html
Modified:
pkg/R/Rd.R
pkg/R/roxygen.R
pkg/inst/doc/Makefile
pkg/man/make.Rd.roclet.Rd
pkg/man/roxygen-package.Rd
Log:
paragraph infelicities within itemize; descriptive package-block; make roxygen-manual along with vignette; hard-coded vignette index including callgraphs
Modified: pkg/R/Rd.R
===================================================================
--- pkg/R/Rd.R 2008-08-25 11:41:02 UTC (rev 184)
+++ pkg/R/Rd.R 2008-08-25 13:09:37 UTC (rev 185)
@@ -76,7 +76,6 @@
#' \item{\code{@@aliases}}{A default alias is plucked from the \code{@@name} or
#' assignee; otherwise, \code{@@alias a b ...} translates
#' to \code{\alias{a}}, \code{\alias{b}}, &c.
-#'
#' If you specify one alias, however, specify them all.}
#' \item{\code{@@concept}}{See \dQuote{2.8 Indices} from
#' \cite{Writing R Extensions}.}
@@ -84,7 +83,6 @@
#' relative to the package head; if the file resides in
#' \file{tests}, for instance, it will be checked with
#' \command{R CMD check}.
-#'
#' The contents of the file will
#' be concatenated under \code{\examples{...}}.}
#' \item{\code{@@examples}}{Verbatim examples; see \dQuote{2.1.1
@@ -108,7 +106,6 @@
#' \item{\code{@@title}}{A default title is plucked from the first sentence
#' of the description; that is, the first phrase ending
#' with a period, question mark or newline.
-#'
#' In the absence of a description, the title becomes
#' the \code{@@name} or assignee; lastly, it can be
#' overridden with \code{@@title}.}
Modified: pkg/R/roxygen.R
===================================================================
--- pkg/R/roxygen.R 2008-08-25 11:41:02 UTC (rev 184)
+++ pkg/R/roxygen.R 2008-08-25 13:09:37 UTC (rev 185)
@@ -3,11 +3,46 @@
#' @export
roxygen <- function() NULL
-#' See the \code{\link{make.Rd.roclet}},
-#' \code{\link{make.namespace.roclet}},
-#' and \code{\link{make.collate.roclet}} pages for
-#' an overview of roxygen tags.
-#' @title Roxygen package
+#' Roxygen is a Doxygen-like documentation system for R; allowing
+#' in-source specification of Rd files, collation and namespace
+#' directives.
+#'
+#' \tabular{ll}{
+#' Package: \tab Roxygen\cr
+#' Type: \tab Package\cr
+#' Version: \tab 0.1\cr
+#' Date: \tab 2008-08-25\cr
+#' License: \tab GPL (>= 2)\cr
+#' LazyLoad: \tab yes\cr
+#' }
+#'
+#' Roxygen is run on a package (hereafter <package>) by
+#' \command{R CMD roxygen <package>} or \command{Rcmd roxygen.sh <package>}
+#' on Windows. By default, it creates a directory \file{<package>.roxygen}
+#' with the complete package cum populated Rd files, \file{NAMESPACE}, etc.;
+#' but can also operate descructively on the package itself with the
+#' \option{-d} option.
+#'
+#' See the vignette (\file{roxygen.pdf}) or manual (\file{roxygen-manual.pdf})
+#' for details.
+#'
+#' @author
+#' Peter Danenberg \email{pcd@@roxygen.org},
+#' Manuel Eugster \email{Manuel.Eugster@@stat.uni-muenchen.de}
+#'
+#' Maintainer: Peter Danenberg \email{pcd@@roxygen.org}
#' @name roxygen-package
#' @docType package
+#' @title Roxygen: Literate Programming in R
+#' @keywords package
+#' @examples
+#' ## To process a package in `pkg', run `R CMD roxygen pkg'; or:
+#' \dontrun{roxygenize('pkg')}
+#' @seealso See \code{\link{make.Rd.roclet}},
+#' \code{\link{make.namespace.roclet}},
+#' \code{\link{make.collate.roclet}},
+#' \code{\link{make.callgraph.roclet}}
+#' for an overview of roxygen tags.
+#'
+#' See \code{\link{roxygenize}} for an alternative to `R CMD roxygen'.
roxygen()
Modified: pkg/inst/doc/Makefile
===================================================================
--- pkg/inst/doc/Makefile 2008-08-25 11:41:02 UTC (rev 184)
+++ pkg/inst/doc/Makefile 2008-08-25 13:09:37 UTC (rev 185)
@@ -1,3 +1,8 @@
+all: roxygen.pdf roxygen-manual.pdf
+
roxygen.pdf: roxygen.tex
pdflatex roxygen && \
pdflatex roxygen
+
+roxygen-manual.pdf:
+ R CMD Rd2dvi --no-preview --pdf -o $@ ../..
Added: pkg/inst/doc/index.html
===================================================================
--- pkg/inst/doc/index.html (rev 0)
+++ pkg/inst/doc/index.html 2008-08-25 13:09:37 UTC (rev 185)
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xml:lang="en" >
+ <head>
+ <title>R: roxygen vignettes</title>
+ <style type="text/css">@import "../../R.css";</style>
+ </head>
+ <body>
+ <h2>Vignettes of package roxygen</h2>
+ <dl>
+ <dt><a href="roxygen.pdf">roxygen.pdf</a>:</dt>
+ <dd>Roxygen vignette</dd>
+ <dt><a href="roxygen-manual.pdf">roxygen-manual.pdf</a>:</dt>
+ <dd>Roxygen manual</dd>
+ <dt><a href="Compose-callgraph.pdf">Compose-callgraph.pdf</a>:</dt>
+ <dd>Callgraph for <code>Compose()</code></dd>
+ <dt><a href="parse.file-callgraph.pdf">parse.file-callgraph.pdf</a>:</dt>
+ <dd>Callgraph for <code>parse.file()</code></dd>
+ <dt><a href="roxygenize-callgraph.pdf">roxygenize-callgraph.pdf</a>:</dt>
+ <dd>Callgraph for <code>roxygenize()</code></dd>
+ </dl>
+ </body>
+</html>
Modified: pkg/man/make.Rd.roclet.Rd
===================================================================
--- pkg/man/make.Rd.roclet.Rd 2008-08-25 11:41:02 UTC (rev 184)
+++ pkg/man/make.Rd.roclet.Rd 2008-08-25 13:09:37 UTC (rev 185)
@@ -35,7 +35,6 @@
\item{\code{@aliases}}{A default alias is plucked from the \code{@name} or
assignee; otherwise, \code{@alias a b ...} translates
to \code{\alias{a}}, \code{\alias{b}}, &c.
-
If you specify one alias, however, specify them all.}
\item{\code{@concept}}{See \dQuote{2.8 Indices} from
\cite{Writing R Extensions}.}
@@ -43,7 +42,6 @@
relative to the package head; if the file resides in
\file{tests}, for instance, it will be checked with
\command{R CMD check}.
-
The contents of the file will
be concatenated under \code{\examples{...}}.}
\item{\code{@examples}}{Verbatim examples; see \dQuote{2.1.1
@@ -67,7 +65,6 @@
\item{\code{@title}}{A default title is plucked from the first sentence
of the description; that is, the first phrase ending
with a period, question mark or newline.
-
In the absence of a description, the title becomes
the \code{@name} or assignee; lastly, it can be
overridden with \code{@title}.}
Modified: pkg/man/roxygen-package.Rd
===================================================================
--- pkg/man/roxygen-package.Rd 2008-08-25 11:41:02 UTC (rev 184)
+++ pkg/man/roxygen-package.Rd 2008-08-25 13:09:37 UTC (rev 185)
@@ -1,8 +1,39 @@
\name{roxygen-package}
\alias{roxygen-package}
-\title{Roxygen package}
-\description{See the \code{\link{make.Rd.roclet}},
+\title{Roxygen: Literate Programming in R}
+\description{Roxygen is a Doxygen-like documentation system for R; allowing
+in-source specification of Rd files, collation and namespace
+directives.}
+\details{\tabular{ll}{
+Package: \tab Roxygen\cr
+Type: \tab Package\cr
+Version: \tab 0.1\cr
+Date: \tab 2008-08-25\cr
+License: \tab GPL (>= 2)\cr
+LazyLoad: \tab yes\cr
+}
+
+Roxygen is run on a package (hereafter <package>) by
+\command{R CMD roxygen <package>} or \command{Rcmd roxygen.sh <package>}
+on Windows. By default, it creates a directory \file{<package>.roxygen}
+with the complete package cum populated Rd files, \file{NAMESPACE}, etc.;
+but can also operate descructively on the package itself with the
+\option{-d} option.
+
+See the vignette (\file{roxygen.pdf}) or manual (\file{roxygen-manual.pdf})
+for details.}
+\author{Peter Danenberg \email{pcd at roxygen.org},
+Manuel Eugster \email{Manuel.Eugster at stat.uni-muenchen.de}
+
+Maintainer: Peter Danenberg \email{pcd at roxygen.org}}
+\docType{package}
+\keyword{package}
+\seealso{See \code{\link{make.Rd.roclet}},
\code{\link{make.namespace.roclet}},
-and \code{\link{make.collate.roclet}} pages for
-an overview of roxygen tags.}
-\docType{package}
+\code{\link{make.collate.roclet}},
+\code{\link{make.callgraph.roclet}}
+for an overview of roxygen tags.
+
+See \code{\link{roxygenize}} for an alternative to `R CMD roxygen'.}
+\examples{## To process a package in `pkg', run `R CMD roxygen pkg'; or:
+\dontrun{roxygenize('pkg')}}
More information about the Roxygen-commits
mailing list