[Genabel-commits] r1646 - in pkg/DatABEL: R man

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

Author: lckarssen
Date: 2014-03-18 10:01:08 +0100 (Tue, 18 Mar 2014)
New Revision: 1646

Modified:
   pkg/DatABEL/R/apply2dfo.R
   pkg/DatABEL/man/apply2dfo.Rd
Log:
Minor updates to DatABEL's apply2dfo() documentation.


Modified: pkg/DatABEL/R/apply2dfo.R
===================================================================
--- pkg/DatABEL/R/apply2dfo.R	2014-03-18 08:35:13 UTC (rev 1645)
+++ pkg/DatABEL/R/apply2dfo.R	2014-03-18 09:01:08 UTC (rev 1646)
@@ -1,12 +1,12 @@
-#' applies a function to 'databel' object
+#' applies a function to a 'databel' object
 #'
 #' An iterator applying a user-defined function to
-#' an object of 'databel-class'
-#' object
+#' an object of 'databel-class'.
 #'
+#'
 #' @param dfodata 'databel' object which is iterated over
 #' @param anFUN user-defined analysis function
-#' @param MAR which margin to iteracte over (default = 2, usually
+#' @param MAR which margin to iterate over (default = 2, usually
 #' these are 'columns' used to store SNP data)
 #' @param procFUN function to process the output and present that as a
 #' fixed-number-of-columns matrix or fixed-length vector. Can be
@@ -17,11 +17,11 @@
 #' [no. missing obs.])
 #' @param outclass output to ("matrix" or "databel")
 #' @param outfile if output class is "databel", the generated object
-#' is bond to the outfile
-#' @param type if output class is "databel", what data tyoe to use for
+#' is bound to the \code{outfile}
+#' @param type if output class is "databel", what data type to use for
 #' storage
 #' @param transpose whether to transpose the output
-#' @param ... arguments passed to the anFUN
+#' @param ... arguments passed to the \code{anFUN}
 #'
 #' @return A matrix (or 'databel'-matrix) containing results of
 #' applying the function

Modified: pkg/DatABEL/man/apply2dfo.Rd
===================================================================
--- pkg/DatABEL/man/apply2dfo.Rd	2014-03-18 08:35:13 UTC (rev 1645)
+++ pkg/DatABEL/man/apply2dfo.Rd	2014-03-18 09:01:08 UTC (rev 1646)
@@ -1,6 +1,6 @@
 \name{apply2dfo}
 \alias{apply2dfo}
-\title{applies a function to 'databel' object}
+\title{applies a function to a 'databel' object}
 \usage{
 apply2dfo(..., dfodata, anFUN = "lm", MAR = 2, procFUN,
   outclass = "matrix", outfile, type = "DOUBLE", transpose = TRUE)
@@ -10,7 +10,7 @@
 
   \item{anFUN}{user-defined analysis function}
 
-  \item{MAR}{which margin to iteracte over (default = 2,
+  \item{MAR}{which margin to iterate over (default = 2,
   usually these are 'columns' used to store SNP data)}
 
   \item{procFUN}{function to process the output and present
@@ -25,14 +25,14 @@
   \item{outclass}{output to ("matrix" or "databel")}
 
   \item{outfile}{if output class is "databel", the
-  generated object is bond to the outfile}
+  generated object is bound to the \code{outfile}}
 
-  \item{type}{if output class is "databel", what data tyoe
+  \item{type}{if output class is "databel", what data type
   to use for storage}
 
   \item{transpose}{whether to transpose the output}
 
-  \item{...}{arguments passed to the anFUN}
+  \item{...}{arguments passed to the \code{anFUN}}
 }
 \value{
 A matrix (or 'databel'-matrix) containing results of
@@ -40,7 +40,7 @@
 }
 \description{
 An iterator applying a user-defined function to an object
-of 'databel-class' object
+of 'databel-class'.
 }
 \examples{
 a <- matrix(rnorm(50), 10, 5)