SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 58 - (download) (as text) (annotate)
Mon Sep 25 09:44:52 2006 UTC (12 years, 11 months ago) by feinerer
Original Path: trunk/R/textmin/man/NewsgroupDocument-class.Rd
File size: 2020 byte(s)
Wrote some documentation.
\name{NewsgroupDocument-class}
\docType{class}
\alias{NewsgroupDocument-class}
\alias{Corpus,NewsgroupDocument-method}
\alias{Corpus<-,NewsgroupDocument-method}
\alias{FileName,NewsgroupDocument-method}
\alias{Cached,NewsgroupDocument-method}
\alias{Cached<-,NewsgroupDocument-method}
\title{Text document}
\description{
  A class representing a newsgroup document with additional
  information. The newsgroup documents must be formatted according to
  the Newsgroup dataset from the UCI KDD archive.
}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("NewsgroupDocument", ...)}.
}
\section{Slots}{
  \describe{
    \item{\code{Newsgroup}:}{Object of class \code{character} containing
      the newsgroups where the document has been posted}
    \item{\code{FileName}:}{Object of class \code{character} containing
      the path and filename holding the data physically on disk}
    \item{\code{Cached}:}{Object of class \code{numeric} containing the
      status whether the file was already loaded in memory. Zero indicates
      not loaded, a value greater zero indicates in memory.}
  }
}
\section{Extends}{
Class \code{character} and \code{TextDocument}, directly.
}
\section{Methods}{
  \describe{
    \item{Corpus}{\code{signature(object = "NewsgroupDocument")}: returns the
      text corpus, i.e., the actual character data slot}
    \item{Corpus<-}{\code{signature(object = "NewsgroupDocument")}: sets the
      text corpus, i.e., the actual character data slot}
    \item{FileName}{\code{signature(object = "NewsgroupDocument")}: returns the
      filename on disk}
    \item{Cached}{\code{signature(object = "NewsgroupDocument")}: returns
      status information for loading on demand}
    \item{Cached<-}{\code{signature(object = "NewsgroupDocument")}: sets
      status information for loading on demand}
  }
}
\references{\url{http://kdd.ics.uci.edu/databases/20newsgroups/20newsgroups.html}}
\author{Ingo Feinerer \email{h0125130@wu-wien.ac.at}}
\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