[Genabel-commits] r795 - pkg/DatABEL/inst/doc

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

Author: lckarssen
Date: 2011-10-19 00:15:20 +0200 (Wed, 19 Oct 2011)
New Revision: 795

Modified:
   pkg/DatABEL/inst/doc/intro_DatABEL.Rnw
Log:
Fixed some typos in the DatABEL vignette.

Modified: pkg/DatABEL/inst/doc/intro_DatABEL.Rnw
===================================================================
--- pkg/DatABEL/inst/doc/intro_DatABEL.Rnw	2011-10-13 14:46:19 UTC (rev 794)
+++ pkg/DatABEL/inst/doc/intro_DatABEL.Rnw	2011-10-18 22:15:20 UTC (rev 795)
@@ -23,8 +23,8 @@
 \section{Introduction}
 
 This vignette demonstrates the use of all major \texttt{DatABEL} 
-functions. Central to \texttt{DatABEL} library is the \texttt{databel} class, which 
-is defined as following:
+functions. Central to the \texttt{DatABEL} library is the \texttt{databel} class, which 
+is defined as follows:
 \begin{verbatim}
 setClass(
     Class = "databel",
@@ -39,7 +39,7 @@
     package = "DatABEL"
 );
 \end{verbatim}
-here, \texttt{data} is external pointer to an instance of \texttt{FilteredMatrix} 
+here, \texttt{data} is an external pointer to an instance of the \texttt{FilteredMatrix} 
 class of \texttt{filevector} library, \texttt{usedRowIndex} and \texttt{usedColIndex} 
 keep the indexes of not masked columns and rows, \texttt{backingfilename} is the 
 base name of the \texttt{filevector} data/index files, and \texttt{cachesizeMb} specifies 
@@ -60,10 +60,10 @@
 \item Connect and disconnect R object of \texttt{databel}-class to/from the 
 underlying binary data (\texttt{connect} and \texttt{disconnect}; these functions 
 destroy or initiate an instance of \texttt{FilteredMatrix}.
-\item Save (sub-set) of \texttt{databel} matrix as new binary set of files (\texttt{save\_as}) 
-or export to plain text files (\texttt{databel2text})
+\item Save a (sub-set of a) \texttt{databel} matrix as a new binary set of files (\texttt{save\_as}) 
+or export to plain text files (\texttt{databel2text}).
 \item Obtain sub-sets of a \texttt{databel} object (operation \texttt{[}).
-\item Replace values in the matrix (operation \texttt{[<-})
+\item Replace values in the matrix (operation \texttt{[<-}).
 \item Coercion of \texttt{databel} matrix to standard R matrix and vector and 
 coercion of R matrix to \texttt{databel} matrix.
 \end{itemize}
@@ -119,7 +119,7 @@
 list.files(pattern="*.fv?")
 @
 
-You can see that after application of \texttt{as} method, 
+You can see that after application of the \texttt{as} method, 
 two files containing data backing the 'dat1' have appeared.
 
 The 'show' method shows basic information for the object:
@@ -127,7 +127,7 @@
 dat1
 @
 
-Note that for big matrices only summaries and small part of the data
+Note that for big matrices only summaries and a small part of the data
 will appear on the screen. 
 
 To keep the naming of the backing files, underlying data type 
@@ -164,7 +164,7 @@
 dat4
 @
 
-Finally, a \texttt{databel} object can be initialized from other \texttt{databel}
+Finally, a \texttt{databel} object can be initialized from another \texttt{databel}
 object
 <<>>=
 dat5 <- dat4
@@ -222,11 +222,11 @@
 @
 
 Additional methods defined for \texttt{databel} matrices
-allow to obtain information about backing file name
+allow to obtain information about the backing file name
 <<<>>=
 backingfilename(dat1)
 @
-and size of cache used 
+and the size of the cache used 
 <<>>=
 cachesizeMb(dat1)
 @
@@ -278,7 +278,7 @@
 newm
 @
 
-A data from \texttt{databel} matrix may be exported to a text file 
+Data from a \texttt{databel} matrix may be exported to a text file 
 using function
 <<>>=
 databel2text(dat2,file="dat2.txt")
@@ -311,8 +311,8 @@
 apply2dfo(Y~SNP+I(SNP^2),dfodata=dat2,anFUN="lm",MAR=2)
 @
 
-Even more complicated analysis may be done by user specifying 
-own analysis and result processing functions (see package 
+Even more complicated analysis may be done by the user specifying 
+their own analysis and result processing functions (see package 
 documentation). 
 
 \section{Citation}