details: Create HTML DOM Details

View source: R/details.R

detailsR Documentation

Create HTML DOM Details

Description

Create HTML DOM Details block for Markdown documents with summary as optional.

Usage

details(
  object,
  ...,
  summary = NULL,
  tooltip = "Click to Expand",
  open = FALSE,
  lang = "r",
  output = c("console", "clipr", "edit", "character", "html"),
  imgur = TRUE,
  comment = NA
)

Arguments

object

object, object to put in details block

...

arguments to pass to print method of the object

summary

character, text to put in summary block, Default: NULL

tooltip

character, text for tooltip on the summary, Default: 'Click to Expand'

open

logical, is the details open (TRUE) or closed (FALSE), Default: FALSE

lang

character, language of block (for markdown highlighting) Default: 'r'

output

character, where to output the file console (Default), clipboard or R file editor, Default: c('console','clipr','file.edit','character')

imgur

logical, upload device outputs to imgur, Default: TRUE

comment

character, the prefix to be put before source code output, Default: NA

Details

To remove summary or tooltip set them to NULL. If the object is a file path, it will automatically it's lines will be read in internally.

If lang is 'none' then the output will not be wrapped in a code block and will display the raw output (useful for HTML)

When using details in knitr/rmarkdown documents there is no need to set the results to 'asis', there are already predefined print methods for these environments.

... is passed to objects that do not invoke an image device.

Value

character

See Also

use_details

Examples


#basic
 details::details('test')

#sessionInfo
 details::details(sessionInfo(), summary = 'sessionInfo')

#data.frame
 details::details(head(mtcars))

#plots

 details(
   plot(x = mtcars$mpg, y = mtcars$wt),
   summary = 'Plots')


#output options

#character
 details::details('test', output = 'character')

#clipboard
if(clipr::clipr_available()){

 details::details('test', output = 'clipr')

 clipr::read_clip()

}

#file.edit


 details::details('test', output = 'edit')
 





yonicd/details documentation built on March 31, 2022, 4:27 a.m.