[Genabel-commits] r1711 - pkg/ProbABEL/src

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

Author: lckarssen
Date: 2014-04-28 18:28:42 +0200 (Mon, 28 Apr 2014)
New Revision: 1711

Modified:
   pkg/ProbABEL/src/regdata.h
Log:
Updated Doxygen documentation for regdata::masked_data from the old text about arrays to the current std::vector().


Modified: pkg/ProbABEL/src/regdata.h
===================================================================
--- pkg/ProbABEL/src/regdata.h	2014-04-28 14:44:07 UTC (rev 1710)
+++ pkg/ProbABEL/src/regdata.h	2014-04-28 16:28:42 UTC (rev 1711)
@@ -83,13 +83,12 @@
     bool is_interaction_excluded;
 
     /**
-     * Pointer to an array that contains ones/zeros to indicate which
-     * data points should be omitted because no genetic data is
-     * present.
+     * A vector that contains ones/zeros to indicate which data points
+     * should be omitted because no genetic data is present.
      *
-     * The array is regdata::nids long. A value of 1 means that that
-     * ID/sample will be masked because the SNP data is NA for that
-     * ID.
+     * The vector is regdata::nids long. A value of 1 or 'true' means
+     * that that ID/sample will be masked because the SNP data is NA
+     * for that ID.
      */
     std::vector<bool> masked_data;