jpegReport: Graphics devices for 'JPEG' format bitmap files.

View source: R/taskFiles.R

jpegReportR Documentation

Graphics devices for JPEG format bitmap files.

Description

Graphics devices for JPEG format bitmap files.

Usage

jpegReport(
  task,
  type,
  ext = "jpg",
  subdir = NULL,
  dirCreate = TRUE,
  dim = c(500, 500),
  width = NULL,
  height = NULL,
  ...
)

Arguments

task

Object of class D4TAlinkTask, as created by initTask.

type

character string, one of "Xlib" or "quartz" (some macOS builds) or "cairo". The latter will only be available if the system was compiled with support for cairo – otherwise "Xlib" will be used. The default is set by getOption("bitmapType") – the ‘out of the box’ default is "quartz" or "cairo" where available, otherwise "Xlib".

ext

Filename extension.

subdir

(optional) Subdirectory.

dirCreate

Logical, if TRUE (by default) the directory is created.

dim

device height and width in px.

width

device height in px.

height

device height in px.

...

Arguments passed on to grDevices::jpeg

filename

the output file path. The page number is substituted if a C integer format is included in the character string, as in the default. (Depending on the platform, the result should be less than PATH_MAX characters long, and may be truncated if not. See postscript for further details.) Tilde expansion is performed where supported by the platform. An input with a marked encoding is converted to the native encoding on an error is given.

units

The units in which height and width are given. Can be px (pixels, the default), in (inches), cm or mm.

pointsize

the default pointsize of plotted text, interpreted as big points (1/72 inch) at res ppi.

bg

the initial background colour: can be overridden by setting par("bg").

quality

the ‘quality’ of the JPEG image, as a percentage. Smaller values will give more compression but also more degradation of the image.

res

The nominal resolution in ppi which will be recorded in the bitmap file, if a positive integer. Also used for units other than the default, and to convert points to pixels.

antialias

for type = "cairo", giving the type of anti-aliasing (if any) to be used for fonts and lines (but not fills). See X11. The default is set by X11.options. Also for type = "quartz", where antialiasing is used unless antialias = "none".

Value

the file name invisibly.


D4TAlink.light documentation built on April 4, 2025, 1:02 a.m.