SCM

SCM Repository

[tm] View of /trunk/tm/man/TermDocMatrix2.Rd
ViewVC logotype

View of /trunk/tm/man/TermDocMatrix2.Rd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 795 - (download) (as text) (annotate)
Sat Oct 27 09:14:35 2007 UTC (11 years, 9 months ago) by feinerer
File size: 1294 byte(s)
Updated documentation
\name{TermDocMatrix2}
\docType{methods}
\alias{TermDocMatrix2}
\alias{TermDocMatrix2,TextDocCol-method}
\title{Term-document matrix}
\description{
  Constructs a term-document matrix.
}
\usage{
TermDocMatrix2(object, control = list())
}
\arguments{
  \item{object}{a text document collection}
  \item{control}{a list of control options. The option \code{weighting}
    must be a weighting function capable of handling a
    \code{dgCMatrix}. It defaults to \code{weightTf} for term frequency
    weighting. All other options are delegated internally to a
    \code{\link{termFreq}} call.}
}
\value{
  An S4 object of class \code{TermDocMatrix} containing a sparse term-document
  matrix. The following slots contain useful information:

  \item{Data}{The sparse \code{Matrix}}
  \item{Weighting}{The weighting mode applied to the term-document matrix}
}
\seealso{
  The documentation to \code{\link{termFreq}} gives an extensive list of
  possible arguments.

  Available weighting functions shipped with this
  package are \code{\link{weightTf}}, \code{\link{weightTfIdf}},
  \code{\link{weightBin}} and \code{\link{weightLogical}}.
}
\examples{
data("crude")
(tdm <- TermDocMatrix2(crude, control = list(weighting = weightTfIdf, stopwords = TRUE)))
}
\author{Ingo Feinerer}
\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