[Phylobase-commits] r902 - pkg/R

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

Author: francois
Date: 2014-04-08 17:20:40 +0200 (Tue, 08 Apr 2014)
New Revision: 902

Modified:
   pkg/R/phylobase.options.R
Log:
updated roxygen formatting for phylobase.options

Modified: pkg/R/phylobase.options.R
===================================================================
--- pkg/R/phylobase.options.R	2014-04-08 15:18:06 UTC (rev 901)
+++ pkg/R/phylobase.options.R	2014-04-08 15:20:40 UTC (rev 902)
@@ -1,29 +1,27 @@
-### Modified code from package sm
-
-
-#' Set or return options of phylobase
-#' 
-#' Provides a mean to control the validity of \code{phylobase} objects such as
-#' singletons, reticulated trees, polytomies, etc.
-#' 
-#' The parameter values set via a call to this function will remain in effect
-#' for the rest of the session, affecting the subsequent behavior of phylobase.
-#' 
-#' @param \dots a list may be given as the only argument, or any number of
-#' arguments may be in the \code{name=value} form, or no argument at all may be
-#' given.  See the Value and Details sections for explanation.
-#' @return A list with the updated values of the parameters. If arguments are
-#' provided, the returned list is invisible.
-#' @author Francois Michonneau (adapted from the package \code{sm})
-#' @keywords phylobase validator
-#' @examples
-#' 
-#' \dontrun{
-#' phylobase.options(poly="fail")
-#' # subsequent trees with polytomies will fail the validity check
-#' }
-#' 
-#' @export phylobase.options
+##' Set or return options of phylobase
+##' 
+##' Provides a mean to control the validity of \code{phylobase}
+##' objects such as singletons, reticulated trees, polytomies, etc.
+##' 
+##' The parameter values set via a call to this function will remain
+##' in effect for the rest of the session, affecting the subsequent
+##' behavior of phylobase.
+##' 
+##' @param \dots a list may be given as the only argument, or any
+##' number of arguments may be in the \code{name=value} form, or no
+##' argument at all may be given.  See the Value and Details sections
+##' for explanation.
+##' @return A list with the updated values of the parameters. If
+##' arguments are provided, the returned list is invisible.
+##' @author Francois Michonneau (adapted from the package \code{sm})
+##' @keywords phylobase validator
+##' @examples
+##' \dontrun{
+##' phylobase.options(poly="fail")
+##' # subsequent trees with polytomies will fail the validity check
+##' }
+##' 
+##' @export phylobase.options
 phylobase.options <- function (...) {
     if (nargs() == 0) return(.phylobase.Options)
     current <- .phylobase.Options