[Roxygen-commits] r188 - in pkg: R inst/doc

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

Author: pcd
Date: 2008-08-26 14:38:31 +0200 (Tue, 26 Aug 2008)
New Revision: 188

Added:
   pkg/inst/doc/pseudoprime-package.R
Modified:
   pkg/R/roxygen.R
Log:
pseudoprime package description; spaces before newlines


Modified: pkg/R/roxygen.R
===================================================================
--- pkg/R/roxygen.R	2008-08-25 13:39:13 UTC (rev 187)
+++ pkg/R/roxygen.R	2008-08-26 12:38:31 UTC (rev 188)
@@ -38,9 +38,9 @@
 #' @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}},
+#' @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.
 #'

Added: pkg/inst/doc/pseudoprime-package.R
===================================================================
--- pkg/inst/doc/pseudoprime-package.R	                        (rev 0)
+++ pkg/inst/doc/pseudoprime-package.R	2008-08-26 12:38:31 UTC (rev 188)
@@ -0,0 +1,34 @@
+#' Tests pseudoprimality by Fermat's Little Theorem.
+#'
+#' \tabular{ll}{
+#' Package: \tab pseudoprime\cr
+#' Type: \tab Package\cr
+#' Version: \tab 1.0\cr
+#' Date: \tab 2008-08-24\cr
+#' License: \tab What license is it under?\cr
+#' LazyLoad: \tab yes\cr
+#' }
+#'
+#' Using the Fermat primality test, pseudoprime checks for primes
+#' probabilistically; the test is fooled every time by Carmichael
+#' numbers.
+#'
+#' \code{\link{is.pseudoprime}} checks a number \code{n} for
+#' pseudoprimality, applying Fermat's test \code{times} times.
+#' 
+#' @name pseudoprime-package
+#' @aliases pseudoprime
+#' @docType package
+#' @title Tests pseudoprimality by Fermat's Little Theorem
+#' @author Peter Danenberg \email{pcd@@roxygen.org}
+#' @references
+#' \url{http://en.wikipedia.org/wiki/Fermat's_little_theorem}
+#'
+#' \url{http://en.wikipedia.org/wiki/Fermat_primality_test}
+#'
+#' \url{http://en.wikipedia.org/wiki/Carmichael_number}
+#' @keywords package
+#' @seealso \code{\link{is.pseudoprime}}
+#' @examples
+#' is.pseudoprime(13, 4)
+roxygen()