[Genabel-commits] r1234 - pkg/GenABEL/R

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

Author: lckarssen
Date: 2013-05-30 13:12:18 +0200 (Thu, 30 May 2013)
New Revision: 1234

Modified:
   pkg/GenABEL/R/export.plink.R
Log:
GenABEL's export.plink() function: some small improvements in the help text. 


Modified: pkg/GenABEL/R/export.plink.R
===================================================================
--- pkg/GenABEL/R/export.plink.R	2013-05-29 22:47:10 UTC (rev 1233)
+++ pkg/GenABEL/R/export.plink.R	2013-05-30 11:12:18 UTC (rev 1234)
@@ -1,28 +1,28 @@
 #' Export GenABEL data in PLINK format
 #'
 #' Export GenABEL data in PLINK format. This function is
-#' a simple wrapper to \code{\link{export.merlin}} function
+#' a simple wrapper to the \code{\link{export.merlin}} function
 #' with specific arguments + few lines of code to
 #' export phenotypes
 #'
 #' @param data GenABEL data object of 'gwaa.data'-class to
-#' be exported
+#' be exported.
 #'
 #' @param filebasename base file name for exported data,
 #' extensions '.ped', '.map' and '.phe' (for phenotype file)
-#' are added for specific output files
+#' are added for specific output files.
 #'
-#' @param phenotypes NULL (no phenotypes exported), "all" for
-#' all phenotypes or a vector of character with names of phneotypes
-#' to be exported
+#' @param phenotypes NULL (no phenotypes exported), "all" (default) for
+#' all phenotypes or a vector of character with names of phenotypes
+#' to be exported.
 #'
-#' @param transpose if FALSE, regular 'tped' files produced, else
-#' 'ped' files are produced
+#' @param transpose if FALSE (default), 'tped' files will be produced, else
+#' 'ped' files are produced.
 #'
-#' @param export012na if true, export in numeric (0, 1, 2, NA) format
-#' (as opposed to ATGC format)
+#' @param export012na if TRUE, export in numeric (0, 1, 2, NA) format,
+#' as opposed to ATGC format (default: FALSE).
 #'
-#' @param ... arguments passed to \code{\link{export.merlin}}
+#' @param ... arguments passed to \code{\link{export.merlin}}.
 #'
 #' @author Yurii Aulchenko
 #'