doMetacomEntropart: Performs an analysis of ecological diversity and structure.

In frareb/inpdfr: Analyse Text Documents Using Ecological Tools

Performs an analysis of ecological diversity and structure.

Description

Uses the entropart-package to analyse the word-occurrence data.frame, considering words as species and documents as communities.

Usage

doMetacomEntropart(
  wordF,
  getPlot = c(TRUE, TRUE, TRUE, TRUE),
  getTextSink = c(TRUE, TRUE, TRUE, TRUE),
  mwidth = 800,
  mheight = 800,
  formatType = "png"
)

Arguments

wordF	The data.frame containing word occurrences.
getPlot	A vector with four logical values. If getPlot[1]==TRUE, the MetaCommunity object is plotted and saved in the RESULTS directory. If getPlot[2]==TRUE, the DivPart analisis is plotted and saved in the RESULTS directory. If getPlot[3]==TRUE, the DivEst analisis is plotted and saved in the RESULTS directory. If getPlot[4]==TRUE, the DivProfile analisis is plotted and saved in the RESULTS directory.
getTextSink	A vector with four logical values. If getTextSink[1]==TRUE, the MetaCommunity object is saved in the RESULTS directory. If getTextSink[2]==TRUE, the DivPart analisis is saved in the RESULTS directory. If getTextSink[3]==TRUE, the DivEst analisis is saved in the RESULTS directory. If getTextSink[4]==TRUE, the DivProfile analisis is saved in the RESULTS directory.
mwidth	The width of the plot in pixels.
mheight	The height of the plot in pixels.
formatType	The format for the output file ("eps", "pdf", "png", "svg", "tiff", "jpeg", "bmp").

Value

A MetaCommunity object (see entropart-package).

Examples

## Not run: 
data("wordOccuDF")
doMetacomEntropart(wordF = wordOccuDF)

## End(Not run)

frareb/inpdfr documentation built on Aug. 30, 2023, 5:24 a.m.