create_hexlogo: Generate hexagon logo from a tableHTML object.

View source: R/create_hexlogo.R

create_hexlogoR Documentation

Generate hexagon logo from a tableHTML object.

Description

The purpose of the function create_hexlogo is to generate the hexagon logo of the tableHTML package.

Usage

create_hexlogo(
  save = TRUE,
  format = "html",
  file = "tableHTML_hexlogo.html",
  complete_html = FALSE,
  ...
)

Arguments

save

A boolean when set to TRUE the logo will be saved in the specified format.

format

A character string to specify the format of the output, it accepts 'html', 'png', or 'jpeg'. Default is 'html'.

file

A character string to specify the name and path to the new file. Should end with '.html', '.png', or '.jpeg', depending on the selected format.

complete_html

Either TRUE or FALSE. Defaults to FALSE. If TRUE then the <html> and <body> tags are also added in the file.

...

Further parameters to pass to webshot.

Details

The function create_hexlogo will generate the hexagon logo of the tableHTML package.

Value

The hexagon logo of the tableHTML package as a tableHTML object.

The output will be shown in the Viewer pane, and can be saved either as an image or as an HTML.

Examples

## Not run: 
create_hexlogo(save = FALSE)

create_hexlogo(format = 'jpeg',
            file = '~/exported_hexlogo.jpeg')

## End(Not run)

LyzandeR/tableHTML documentation built on April 17, 2023, 3:57 p.m.