SCM

SCM Repository

[tm] Annotation of /trunk/tm/man/NewsgroupDocument-class.Rd
ViewVC logotype

Annotation of /trunk/tm/man/NewsgroupDocument-class.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 67 - (view) (download) (as text)
Original Path: trunk/R/textmin/man/NewsgroupDocument-class.Rd

1 : feinerer 58 \name{NewsgroupDocument-class}
2 :     \docType{class}
3 :     \alias{NewsgroupDocument-class}
4 :     \alias{Corpus,NewsgroupDocument-method}
5 :     \alias{Corpus<-,NewsgroupDocument-method}
6 : feinerer 67 \alias{URI,NewsgroupDocument-method}
7 : feinerer 58 \alias{Cached,NewsgroupDocument-method}
8 :     \alias{Cached<-,NewsgroupDocument-method}
9 :     \title{Text document}
10 :     \description{
11 :     A class representing a newsgroup document with additional
12 :     information. The newsgroup documents must be formatted according to
13 :     the Newsgroup dataset from the UCI KDD archive.
14 :     }
15 :     \section{Objects from the Class}{
16 :     Objects can be created by calls of the form \code{new("NewsgroupDocument", ...)}.
17 :     }
18 :     \section{Slots}{
19 :     \describe{
20 :     \item{\code{Newsgroup}:}{Object of class \code{character} containing
21 :     the newsgroups where the document has been posted}
22 : feinerer 67 \item{\code{URI}:}{Object of class \code{character} containing
23 : feinerer 58 the path and filename holding the data physically on disk}
24 :     \item{\code{Cached}:}{Object of class \code{numeric} containing the
25 :     status whether the file was already loaded in memory. Zero indicates
26 :     not loaded, a value greater zero indicates in memory.}
27 :     }
28 :     }
29 :     \section{Extends}{
30 :     Class \code{character} and \code{TextDocument}, directly.
31 :     }
32 :     \section{Methods}{
33 :     \describe{
34 :     \item{Corpus}{\code{signature(object = "NewsgroupDocument")}: returns the
35 :     text corpus, i.e., the actual character data slot}
36 :     \item{Corpus<-}{\code{signature(object = "NewsgroupDocument")}: sets the
37 :     text corpus, i.e., the actual character data slot}
38 : feinerer 67 \item{URI}{\code{signature(object = "NewsgroupDocument")}: returns the
39 : feinerer 58 filename on disk}
40 :     \item{Cached}{\code{signature(object = "NewsgroupDocument")}: returns
41 :     status information for loading on demand}
42 :     \item{Cached<-}{\code{signature(object = "NewsgroupDocument")}: sets
43 :     status information for loading on demand}
44 :     }
45 :     }
46 :     \references{\url{http://kdd.ics.uci.edu/databases/20newsgroups/20newsgroups.html}}
47 : feinerer 62 \author{Ingo Feinerer}
48 : feinerer 58 \keyword{classes}

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