SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 726 - (view) (download) (as text)

1 : feinerer 58 \name{TextDocCol}
2 :     \docType{methods}
3 :     \alias{TextDocCol}
4 : feinerer 67 \alias{TextDocCol,Source-method}
5 : feinerer 58 \title{Text document collection}
6 :     \description{
7 : feinerer 62 Constructs a text document collection.
8 : feinerer 58 }
9 :     \usage{
10 : feinerer 726 \S4method{TextDocCol}{Source}(object, readerControl(reader = readPlain,
11 :     language = "en_US", load = FALSE), dbControl(dbUse = FALSE, dbName = "",
12 :     dbType = "DB1", ...)
13 : feinerer 58 }
14 :     \arguments{
15 : feinerer 690 \item{object}{a \code{Source} object.}
16 : feinerer 726 \item{readerControl}{a list with the named components \code{reader}
17 :     representing a reading function capable of handling the file format
18 :     found in \code{object}, \code{language} giving the text's language, and
19 :     \code{load} being a logical value indicating whether the text corpus of
20 :     documents should be loaded immediately into memory (\code{load = TRUE}) or loaded when
21 : feinerer 694 necessary (\code{load = FALSE}). This allows to minimize memory
22 :     demands for large document collections. If \code{object} does not
23 :     support load on demand the text corpus is automatically loaded,
24 : feinerer 726 i.e., this argument is overruled..}
25 :     \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 : feinerer 58 }
32 :     \value{
33 :     An S4 object of class \code{TextDocCol} which extends the class
34 :     \code{list} containing a collection of text documents.
35 :     }
36 : feinerer 726 \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 : feinerer 62 \author{Ingo Feinerer}
45 : feinerer 58 \keyword{methods}

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