SCM

SCM Repository

[tm] Diff of /trunk/tm/man/TextDocCol.Rd
ViewVC logotype

Diff of /trunk/tm/man/TextDocCol.Rd

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 725, Fri Apr 6 01:10:28 2007 UTC revision 726, Sun Apr 8 00:31:22 2007 UTC
# Line 7  Line 7 
7    Constructs a text document collection.    Constructs a text document collection.
8  }  }
9  \usage{  \usage{
10  \S4method{TextDocCol}{Source}(object, parser = readPlain, load = FALSE,...)  \S4method{TextDocCol}{Source}(object, readerControl(reader = readPlain,
11    language = "en_US", load = FALSE), dbControl(dbUse = FALSE, dbName = "",
12    dbType = "DB1", ...)
13  }  }
14  \arguments{  \arguments{
15    \item{object}{a \code{Source} object.}    \item{object}{a \code{Source} object.}
16    \item{parser}{a parsing function capable of handling the file format    \item{readerControl}{a list with the named components \code{reader}
17      found in \code{object}.}      representing a reading function capable of handling the file format
18    \item{load}{a logical value indicating whether the text corpus of      found in \code{object}, \code{language} giving the text's language, and
19      documents should      \code{load} being a logical value indicating whether the text corpus of
20      be loaded immediately into memory (\code{load = TRUE}) or loaded when      documents should be loaded immediately into memory (\code{load = TRUE}) or loaded when
21      necessary (\code{load = FALSE}). This allows to minimize memory      necessary (\code{load = FALSE}). This allows to minimize memory
22      demands for large document collections. If \code{object} does not      demands for large document collections. If \code{object} does not
23      support load on demand the text corpus is automatically loaded,      support load on demand the text corpus is automatically loaded,
24      i.e., this argument is overruled.}      i.e., this argument is overruled..}
25    \item{...}{optional arguments for the \code{parser}.}    \item{dbControl}{a list with the named components \code{useDb}
26        indicating that database support should be activated, \code{dbName}
27        giving the filename holding the sourced out objects (i.e., the
28        database), and \code{dbType} holding a valid database type as
29        supported by \pkg{filehash}.}
30      \item{...}{optional arguments for the \code{reader}.}
31  }  }
32  \value{  \value{
33    An S4 object of class \code{TextDocCol} which extends the class    An S4 object of class \code{TextDocCol} which extends the class
34    \code{list} containing a collection of text documents.    \code{list} containing a collection of text documents.
35  }  }
36    \examples{
37    txt <- system.file("texts", "txt", package = "tm")
38    \dontrun{(TextDocCol(DirSource(txt), readerControl = list(reader
39    = readPlain, language = "en_US", load = TRUE), dbControl = list(useDb =
40    TRUE, dbName = "oviddb", dbType = "DB1")))}
41    reut21578 <- system.file("texts", "reut21578", package = "tm")
42    TextDocCol(DirSource(reut21578), readerControl = list(reader = readReut21578XML, language = "en_US", load = FALSE))
43    }
44  \author{Ingo Feinerer}  \author{Ingo Feinerer}
45  \keyword{methods}  \keyword{methods}

Legend:
Removed from v.725  
changed lines
  Added in v.726

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge