[Lme4-commits] r1657 - pkg/lme4Eigen/R

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

Author: bbolker
Date: 2012-03-15 21:00:54 +0100 (Thu, 15 Mar 2012)
New Revision: 1657

Modified:
   pkg/lme4Eigen/R/AllGeneric.R
Log:

  doxygen tweaks for mcmcsamp



Modified: pkg/lme4Eigen/R/AllGeneric.R
===================================================================
--- pkg/lme4Eigen/R/AllGeneric.R	2012-03-15 18:53:12 UTC (rev 1656)
+++ pkg/lme4Eigen/R/AllGeneric.R	2012-03-15 20:00:54 UTC (rev 1657)
@@ -22,12 +22,11 @@
 ##' distribution of the parameters
 ##'
 ##' 
-##' @title Create an McMC sample
+##' @title Create an MCMC sample
 ##' @param object a fitted model object
-##' @param n number of samples to generate.  Defaults to 1 but that
-##'     value doesn't make sense.
+##' @param n number of samples to generate.  Defaults to 1; for real use values of 200-1000 are more typical
 ##' @param verbose should verbose output be given?
-##' @param ... 
+##' @param ... additional, optional arguments (not used)
 ##' @return a Markov chain Monte Carlo sample as a matrix
 mcmcsamp <- function(object, n = 1L, verbose = FALSE, ...) UseMethod("mcmcsamp")