multiterm_barplot: multiterm_barplot: Use the data from multi_term_arima to...

In tlcaputi/gtrendR: An R Complement to the gtrends Python package

multiterm_barplot: Use the data from multi_term_arima to create a barplot

Description

multiterm_barplot: Use the data from multi_term_arima to create a barplot

Usage

multiterm_barplot(
  multiterm_list,
  label_df = NA,
  title = NULL,
  xlab = "Terms",
  ylab = "Greater than Expected (%)",
  ylim = NULL,
  space = 0.8,
  colorscheme = "blue",
  hicol = NA,
  save = T,
  outfn = "./output/panG.png",
  width = 6,
  height = 3,
  barlabels = T
)

Arguments

multiterm_list	A dataframe including time as timestamp and searches for your given geography in one column.
save	Default is True, If False, don't save
outfn	Output filename
width	Width of file in inches
height	Height of file in inches
interrupt	The date where things change. ARIMA will be predicted on all days before the interrupt.
beginperiod	How far back you want the "pre" period to go
preperiod	This creates a beginperiod but with a number of days instead of a date
endperiod	How far after the interruption you want to go
scaletitle	Title of the scale
scalelimits	vector of two values for min and max for the scale
linecol	Line color
lowcol	Color for low values
midcol	Color for mid values
highcol	Color for high values

Examples

panG <- multiterm_barplot(
  df = multiterms,

  ## Graphing Parameters
  title = NULL, # If NULL, no Title
  xlab = "Terms", # x axis label
  label_df = NA, # Use a two-column dataframe to label the barplot x axis
  ylab = "Greater than Expected (%)", # y axis label
  space = 0.8, # space between bars

  ## Set a colorscheme
  colorscheme = "blue",  # Color schemes set in this package "red", 'blue" or "jamaim"

  # ... customize any color using these
  hicol = NA, # Color of bars

  ## Saving arguments
  save = T, # If T, save plot
  outfn = './output/panG.png', # Location to save plot
  width = 6, # Width in inches
  height = 3 # Height in inches
)

tlcaputi/gtrendR documentation built on Nov. 3, 2022, 10:46 p.m.