wm: A wrapper for the wrightMap() function from the WrightMap...

Description Usage Arguments Value

Description

A wrapper for the wrightMap() function from the WrightMap package.

Usage

1
2
wm(results, dim = NULL, byCat = FALSE, palette = "BASS",
  writeout = FALSE, imageType = "pdf", fileSuffix = NULL)

Arguments

results

The output from a run of craschR. (link?)

dim

A numeric vector that specifies for which dimension(s) to create graphic/tables. If NULL, output and graphics for each dimension will be produced.

byCat

A logical indicating if items/steps should be grouped by the construct category. If FALSE, items will be plotted in the order of itemInfo.

palette

A character string indicating the color scheme. Can be "BASS" or any RColorBrewer palette. If you want to customize further, the wrightMap() function should be used directly, not this wrapper.

writeout

A logical indicating whether the graphic should be written to to your working directory as your specified imageType. If TRUE, the file name will begin WM and will include an index (if more than one graph is produced) and the fileSuffix if provided.

imageType

A character string indicating the format for graphics (if writeout = TRUE). Supported types: c("pdf","svg","jpeg","bmp","tiff","png").

fileSuffix

A character string that will be affixed to the end of each file name (if writeout = TRUE). Use this if you are conducting multiple analyses in the same working directory and do not wish for your existing files to be overwritten.

Value

Wright Map graphic (multiple graphics will be produced if you have more than one dimension and ran consecutive analyses)


amyarneson/crasch documentation built on May 10, 2019, 10:29 a.m.