wvioplot_list: wvioplot_list

Description Usage Arguments Examples

View source: R/MarkdownReportsDev.R

Description

Create and save violin plots as .pdf, in "OutDir". It requires (and calls) "vioplot" package. If mdlink = TRUE, it inserts a .pdf and a .png link in the markdown report, set by "path_of_report". The .png version is not created, only the link is put in place, not to overwrite previous versions.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
wvioplot_list(
  yourlist,
  ...,
  main = as.character(substitute(yourlist)),
  sub = NULL,
  xlab = names(yourlist),
  ylab = "",
  ylim = FALSE,
  col = c(2:(length(yourlist) + 1)),
  incrBottMarginBy = 0,
  tilted_text = FALSE,
  yoffset = 0,
  savefile = unless.specified("b.save.wplots"),
  w = unless.specified("b.defSize", 7),
  h = w,
  mdlink = ww.set.mdlink(),
  PNG = unless.specified("b.usepng", F)
)

Arguments

yourlist

Input list to be plotted.

...

Pass any other parameter of the corresponding plotting function(most of them should work).

main

Title of the plot (main parameter) and also the name of the file.

sub

Subtitle below the plot.

xlab

X-axis label.

ylab

Y-axis label.

ylim

Manual y axis limits

col

Color of the plot.

incrBottMarginBy

Increase the blank space at the bottom of the plot. Use if labels do not fit on the plot.

tilted_text

Use 45 degree x-labels if TRUE. Useful for long, but not too many labels.

yoffset

Offset for X axis labels (in vertical / Y dimension).

savefile

Save plot as pdf in OutDir, TRUE by default.

w

Width of the saved pdf image, in inches.

h

Height of the saved pdf image, in inches.

mdlink

Insert a .pdf and a .png image link in the markdown report, set by "path_of_report".

PNG

Set to true if you want to save the plot as PNG instead of the default PDF.

Examples

1
2
3
try.dev.off(); my.ls = list(A = rnorm(10), B = rnorm(10), C = rnorm(10));
# wvioplot_list (yourlist = my.ls, xlab = names(yourlist), ylab = "", incrBottMarginBy = 0,
# w = 7, tilted_text = FALSE, mdlink = FALSE)

vertesy/MarkdownReportsDev documentation built on Nov. 15, 2021, 9:59 a.m.