plot.polarity: Plots a polarity Object

View source: R/polarity.R

plot.polarityR Documentation

Plots a polarity Object

Description

Plots a polarity object as a heat map Gantt plot with polarity over time (measured in words) and polarity scores per sentence. In the dotplot plot the black dots are the average polarity per grouping variable.

Usage

## S3 method for class 'polarity'
plot(
  x,
  bar.size = 5,
  low = "blue",
  mid = "grey99",
  high = "red",
  ave.polarity.shape = "+",
  alpha = 1/4,
  shape = 19,
  point.size = 2.5,
  jitter = 0.1,
  nrow = NULL,
  na.rm = TRUE,
  order.by.polarity = TRUE,
  plot = TRUE,
  error.bars = TRUE,
  error.bar.height = 0.5,
  error.bar.size = 0.5,
  error.bar.color = "black",
  ...
)

Arguments

x

The polarity object.

bar.size

The size of the bars used in the Gantt plot.

low

The color to be used for lower values.

mid

The color to be used for mid-range values (default is a less striking color).

high

The color to be used for higher values.

ave.polarity.shape

The shape of the average polarity score used in the dot plot.

alpha

Transparency level of points (ranges between 0 and 1).

shape

The shape of the points used in the dot plot.

point.size

The size of the points used in the dot plot.

jitter

Amount of vertical jitter to add to the points.

nrow

The number of rows in the dotplot legend (used when the number of grouping variables makes the legend too wide). If NULL no legend if plotted.

na.rm

logical. Should missing values be removed?

order.by.polarity

logical. If TRUE the group polarity plot will be ordered by average polarity score, otherwise alphabetical order is assumed.

plot

logical. If TRUE the plot will automatically plot. The user may wish to set to FALSE for use in knitr, sweave, etc. to add additional plot layers.

error.bars

logical. If TRUE error bars are added to the polarity dot plot using the standard error of the mean polarity score.

error.bar.height

The height of the error bar ends.

error.bar.size

The size/thickness of the error bars.

error.bar.color

The color of the error bars. If NULL each bar will be colored by grouping variable.

...

ignored

Value

Invisibly returns the ggplot2 objects that form the larger plot.


qdap documentation built on May 31, 2023, 5:20 p.m.