R/02_method_plot.kRp.text.R

In unDocUMeantIt/koRpus: Text Analysis with Emphasis on POS Tagging, Readability, and Lexical Diversity

# Copyright 2010-2021 Meik Michalke <meik.michalke@hhu.de>
#
# This file is part of the R package koRpus.
#
# koRpus is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# koRpus is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with koRpus.  If not, see <http://www.gnu.org/licenses/>.


#' Plot method for objects of class kRp.text
#'
#' Plot method for S4 objects of class \code{\link[koRpus:kRp.text-class]{kRp.text}},
#' plots the frequencies of tagged word classes.
#'
#' @param x An object of class \code{kRp.text}
#' @param y From the generic \code{plot} function, ignored for koRpus class objects.
#' @param what Character string, valid options are:
#'    \describe{
#'      \item{\code{"wclass"}:}{Barplot of distribution of word classes}
#'      \item{\code{"letters"}:}{Line plot of distribution of word length in letters}
#'    }
#' @param ... Any other argument suitable for plot()
#' @seealso \code{\link[koRpus:kRp.text-class]{kRp.text}}
#' @keywords methods plot
#' @export
#' @docType methods
#' @rdname plot-methods
#' @example inst/examples/if_lang_en_clause_start.R
#' @example inst/examples/define_sample_file.R
#' @examples
#'   tokenized.obj <- tokenize(
#'     txt=sample_file,
#'     lang="en"
#'   )
#'   plot(tokenized.obj)
#' @example inst/examples/if_lang_en_clause_end.R
setGeneric("plot", function(x, y, ...) standardGeneric("plot"))

#' @export
#' @docType methods
#' @rdname plot-methods
#' @aliases plot,kRp.text,missing-method
#' @include 01_class_01_kRp.text.R
#' @import graphics
setMethod("plot", signature(x="kRp.text", y="missing"), function(x, what="wclass", ...){
  if(identical(what, "wclass")){
    wclass.distrib <- summary(x)
    # Increase bottom margin to make room for rotated labels
    par(mar = c(7, 4, 4, 2) + 0.1)
    barplot.ticks <- barplot(wclass.distrib[,1], xlab="", ylab="frequency", main="Distribution of word classes", xaxt="n", ...)
    axis(1, at=barplot.ticks, labels=FALSE)
    labels <- rownames(wclass.distrib)
    text(barplot.ticks, par("usr")[3]-6, srt=45, adj=1, labels=labels, xpd=TRUE)
    mtext(1, text="word class", line=6)
  } else if(identical(what, "letters")){
    lttr.distrib <- describe(x)[["lttr.distrib"]]
    plot(lttr.distrib["pct",], type="l", xlab="letters", ylab="percent", main="Distribution of word lengths (letters)", xaxt="n", ...)
    axis(1, at=c(1:ncol(lttr.distrib)), labels=colnames(lttr.distrib))
  } else {}
})