foldercloud: foldercloud

Description Usage Arguments Value

Description

takes in the path of a folder containing pdfs. Performs frequency analysis and produces a wordcloud.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
foldercloud(
  folder,
  cloudname = NULL,
  subfolders = TRUE,
  max.words = 500,
  scale = c(4, 0.28),
  min.freq = 3,
  width = 17,
  height = 17,
  units = "cm",
  res = 600,
  save = T,
  caps = F,
  exclude = c(),
  ...
)

Arguments

folder

a string. The path to a folder, or the path to a pdf

cloudname

a string. The name of the destination file. Include document type. Default is "wordcloud.png".

subfolders

a logical. If TRUE, the algorithm will find all pdfs in all subfolders of the target path

max.words

a numeric. Maximum number of words to be plotted. least frequent terms dropped

scale

a numeric vector. Scale indicates how minimum and maximum word size.

min.freq

a numeric. Words with frequency below min.freq will not be plotted

width

a numeric. How many units wide to make the final plot.

height

a numeric. How many units high to make the final plot.

units

a string. The units in which height and width are given. Can be px (pixels), in (inches), cm(default) or mm.

res

a numeric. The nominal resolution in ppi (pixels per inch) which will be recorded in the bitmap file. Default is 600ppi.

save

a boolean. If save is set to True, a wordcloud will be saved to your working directory.

caps

a boolean. If caps is set to true, all words will be capitalised.

exclude

a charcater vector. Words in this vector will be excluded from the final plot.

...

additional arguments may be passed to the word cloud here.

Value

A list containing a word frequency table, and a wordcloud


JConigrave/foldercloud documentation built on Feb. 2, 2020, 8:04 a.m.