-
Notifications
You must be signed in to change notification settings - Fork 4
/
trim.Rd
33 lines (28 loc) · 779 Bytes
/
trim.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/wfm.R
\name{trim}
\alias{trim}
\title{Trim a Word Frequency Data}
\usage{
trim(wfm, min.count = 5, min.doc = 5, sample = NULL, verbose = TRUE)
}
\arguments{
\item{wfm}{an object of class wfm, or a data matrix}
\item{min.count}{the smallest permissible word count}
\item{min.doc}{the fewest permissible documents a word can appear in}
\item{sample}{how many words to randomly retain}
\item{verbose}{whether to say what we did}
}
\value{
If \code{sample} is a number then this many words will be retained
after \code{min.doc} and \code{min.doc} filters have been applied.
}
\description{
Ejects low frequency observations and subsamples
}
\author{
Will Lowe
}
\seealso{
\code{\link{wfm}}
}