Help for package rvg

Type:

Package

Title:

R Graphics Devices for 'Office' Vector Graphics Output

Version:

0.4.1

Description:

Vector Graphics devices for 'Microsoft PowerPoint' and 'Microsoft Excel'. Functions extending package 'officer' are provided to embed 'DrawingML' graphics into 'Microsoft PowerPoint' presentations and 'Microsoft Excel' workbooks.

License:

GPL-3

URL:

https://ardata-fr.github.io/officeverse/, https://davidgohel.github.io/rvg/

BugReports:

https://github.com/davidgohel/rvg/issues

Depends:

R (≥ 3.0)

Imports:

gdtools (≥ 0.5.0), grDevices, officer (≥ 0.6.2), Rcpp (≥ 0.12.12), rlang, systemfonts, xml2 (≥ 1.0.0)

Suggests:

grid, testthat

LinkingTo:

Rcpp, systemfonts

Encoding:

UTF-8

RoxygenNote:

7.3.3

SystemRequirements:

libpng

NeedsCompilation:

yes

Packaged:

2026-02-16 10:49:05 UTC; davidgohel

Author:

David Gohel [aut, cre], ArData [cph], Bob Rudis [ctb] (the javascript code used by function set_attr), Francois Brunetti [ctb] (clipping algorithms)

Maintainer:

David Gohel <david.gohel@ardata.fr>

Repository:

CRAN

Date/Publication:

2026-02-16 11:20:02 UTC

Defunct Functions in Package rvg

Description

Defunct Functions in Package rvg

Usage

body_add_vg(...)

Arguments

...

unused argument

Details

body_add_vg() is removed and can be replaced by officer::body_add_img.

Wrap plot instructions for DrawingML plotting in Powerpoint

Description

A simple wrapper to mark the plot instructions as Vector Graphics instructions. It produces an object of class 'dml' with a corresponding method ph_with.

The function enables usage of any R plot with argument code and with ggplot objects with argument ggobj.

Note: the output is a vector graphic, not a native Microsoft Office chart. The underlying data is not embedded in the document.

Usage

dml(
  code,
  ggobj = NULL,
  bg = "white",
  fonts = list(),
  pointsize = 12,
  editable = TRUE,
  ...
)

Arguments

code

plotting instructions

ggobj

ggplot object to print. argument code will be ignored if this argument is supplied.

bg, fonts, pointsize, editable

Parameters stored and later passed to dml_pptx by ph_with.dml.

...

unused arguments

background color

When dealing with a ggplot object, the bg parameter sets the device background but the ggplot theme's plot.background will typically draw over it. To control the background appearance, set it in the theme instead:

theme(
  panel.background = element_rect(fill = "#EFEFEF"),
  plot.background = element_rect(fill = "wheat"))

Limitations

The DrawingML format does not support the following R graphics features:

Patterns and gradients: grid patterns (GridPattern), linear and radial gradients used as fill are not translated into DrawingML. ggplot2 will emit a warning when these are used.
Rich text (ggtext/gridtext): packages such as ggtext render HTML/Markdown into composite grid grobs. The rvg device can only capture low-level primitives (text strings, lines, polygons), so the rich formatting (inline images, coloured spans, HTML markup) is lost. Use standard ggplot2 text functions or apply formatting after export in PowerPoint.
Plotmath expressions: R's graphics engine decomposes expression() into individual text primitives before the device sees them. Compound expressions (e.g. expression("a" * "b"), superscripts, subscripts) are rendered as separate text boxes, causing vertical misalignment.
Clipping paths, masks, compositing and transformations: these R >= 4.1 features have no DrawingML equivalent and are silently ignored.

Examples

anyplot <- dml(code = barplot(1:5, col = 2:6), bg = "wheat")

library(officer)
doc <- read_pptx()
doc <- add_slide(doc, "Title and Content", "Office Theme")
doc <- ph_with(doc, anyplot, location = ph_location_fullsize())
fileout <- tempfile(fileext = ".pptx")
# fileout <- "vg.pptx"
print(doc, target = fileout)

DrawingML graphic device for Microsoft PowerPoint

Description

Graphics devices for Microsoft PowerPoint DrawingML format.

Usage

dml_pptx(
  file = "Rplots.dml",
  width = 6,
  height = 6,
  offx = 1,
  offy = 1,
  bg = "white",
  fonts = list(),
  pointsize = 12,
  editable = TRUE,
  id = 1L,
  last_rel_id = 1L,
  raster_prefix = "raster_",
  standalone = TRUE
)

Arguments

file

the file where output will appear.

height, width

Height and width in inches.

offx, offy

top and left origin of the plot

bg

Default background color for the plot (defaults to "white").

fonts

Named list of font names to be aliased with fonts installed on your system. If unspecified, the R default families sans, serif, mono and symbol are aliased to the families detected by gdtools::font_set_auto().

Important: fonts are referenced by name in the DrawingML output and are not embedded. The reader of the PowerPoint file must also have the same fonts installed, otherwise Office will substitute them. For maximum portability, prefer fonts bundled with Microsoft Office such as "Arial", "Times New Roman" and "Courier New".

Fonts must be installed on your system; use gdtools::font_family_exists() to verify availability.

Example: list(sans = "Arial", serif = "Times New Roman", mono = "Courier New").

pointsize

default point size.

editable

should vector graphics elements (points, text, etc.) be editable.

id

specifies a unique identifier (integer) within the slide that will contain the DrawingML instructions.

last_rel_id

specifies the last unique identifier (integer) within relationship file that will be used to reference embedded raster images if any.

raster_prefix

string value used as prefix for png files produced when raster objects are printed on the graphical device.

standalone

produce a standalone drawingml file? If FALSE, omits xml header and namespaces.

Examples


dml_pptx(file = tempfile())
plot(1:11, (-5:5)^2, type = "b", main = "Simple Example")
dev.off()

DrawingML graphic device for Microsoft Excel

Description

Graphics devices for Microsoft Excel DrawingML format.

Usage

dml_xlsx(
  file = "Rplots.dml",
  width = 6,
  height = 6,
  offx = 1,
  offy = 1,
  bg = "white",
  fonts = list(),
  pointsize = 12,
  editable = TRUE,
  id = 1L,
  last_rel_id = 1L,
  standalone = TRUE
)

Arguments

file

the file where output will appear.

height, width

Height and width in inches.

offx, offy

top and left origin of the plot

bg

Default background color for the plot (defaults to "white").

fonts

Important: fonts are referenced by name in the DrawingML output and are not embedded. The reader of the Excel file must also have the same fonts installed, otherwise Office will substitute them. For maximum portability, prefer fonts bundled with Microsoft Office such as "Arial", "Times New Roman" and "Courier New".

Fonts must be installed on your system; use gdtools::font_family_exists() to verify availability.

Example: list(sans = "Arial", serif = "Times New Roman", mono = "Courier New").

pointsize

default point size.

editable

should vector graphics elements (points, text, etc.) be editable.

id

specifies a unique identifier (integer) within the sheet that will contain the DrawingML instructions.

last_rel_id

specifies the last unique identifier (integer) within relationship file that will be used to reference embedded raster images if any.

standalone

produce a standalone drawingml file? If FALSE, omits xml header and namespaces.

Examples


dml_xlsx(file = tempfile())
plot(1:11, (-5:5)^2, type = "b", main = "Simple Example")
dev.off()

add a plot output as vector graphics into a PowerPoint object

Description

Produces a vector graphics output from R plot instructions stored in a dml object and adds the result in an rpptx object produced by read_pptx.

Usage

## S3 method for class 'dml'
ph_with(x, value, location, ...)

Arguments

x

a pptx device

value

dml object

location

a location for a placeholder.

...

Arguments to be passed to methods

Examples

anyplot <- dml(code = barplot(1:5, col = 2:6), bg = "wheat")

library(officer)
doc <- read_pptx()
doc <- add_slide(doc, "Title and Content", "Office Theme")
doc <- ph_with(doc, anyplot, location = ph_location_fullsize())

fileout <- tempfile(fileext = ".pptx")
print(doc, target = fileout)

add a plot output as vector graphics into an Excel object

Description

Produces a vector graphics output from R plot instructions and adds the result in an Excel sheet.

Usage

xl_add_vg(x, sheet, code, left, top, width, height, ...)

Arguments

x

an rxlsx object produced by officer::read_xlsx

sheet

sheet label/name

code

plot instructions

left, top

left and top origin of the plot on the sheet in inches.

height, width

Height and width in inches.

...

arguments passed on to dml_xlsx.

Examples


library(officer)
my_ws <- read_xlsx()
my_ws <- xl_add_vg(my_ws,
  sheet = "Feuil1",
  code = barplot(1:5, col = 2:6), width = 6, height = 6, left = 1, top = 2
)
fileout <- tempfile(fileext = ".xlsx")
print(my_ws, target = fileout)

Defunct Functions in Package rvg

Description

Usage

Arguments

Details

Wrap plot instructions for DrawingML plotting in Powerpoint

Description

Usage

Arguments

background color

Limitations

See Also

Examples

DrawingML graphic device for Microsoft PowerPoint

Description

Usage

Arguments

See Also

Examples

DrawingML graphic device for Microsoft Excel

Description

Usage

Arguments

See Also

Examples

add a plot output as vector graphics into a PowerPoint object

Description

Usage

Arguments

Examples

add a plot output as vector graphics into an Excel object

Description

Usage

Arguments

Examples