Create HTML Tabs for Multiple Objects

Description

This function generates a tabbed HTML interface for displaying multiple R objects such as 'ggplot2' plots and data frames. Each tab can include custom arguments for rendering (e.g., image width or table formatting).

Usage

create_tabs(...)

Arguments

Details

Supported object types:

• 'ggplot' objects — rendered as base64-encoded images using 'save_base64()'

• 'data.frame' or 'tibble' — rendered using 'kable_html()'

Additional arguments passed inside the list are used by the relevant rendering function.

Value

A 'htmltools::tag' object representing the full tab interface. Can be printed in R Markdown documents or displayed interactively in RStudio Viewer.

Examples

## Not run: 
library(ggplot2)

# Simple plot and table
p <- ggplot(cars) + geom_point(aes(speed, dist))
df <- head(cars)

# Basic usage
create_tabs(
  plot = p,
  table = df
)

# With custom rendering arguments
create_tabs(
  plot = list(object = p, width = 4),
  table = list(object = df, digits = 2)
)

## End(Not run)

Delete a tiddler

Description

Delete a tiddler

Usage

delete_tiddler(title, bag = TW_OPTIONS("bag"))

Arguments

Value

no return values

Examples

## Not run: 
delete_tiddler("GettingStarted")

## End(Not run)

Get server status

Description

Get server status

Usage

get_status()

Value

a list of service status

Get a tiddler

Description

Get a tiddler

Usage

get_tiddler(title, recipe = TW_OPTIONS("recipe"))

Arguments

Value

tiddler information in JSON format

Examples

## Not run: 
get_tiddler("GettingStarted")

## End(Not run)

Get all tiddlers

Description

Get all tiddlers

Usage

get_tiddlers(filter = NULL, exclude = NULL, recipe = TW_OPTIONS("recipe"))

Arguments

Value

all tiddlers information in JSON format

Examples

## Not run: 
#' Get all tiddlers
get_tiddlers()

## End(Not run)

Convert Data Frame to HTML Table using kable

Description

Convert Data Frame to HTML Table using kable

Usage

kable_html(df, ...)

Arguments

Value

A htmltools object containing the HTML representation of the table.

Examples

kable_html(cars[1:10,])

Print tw_html object

Description

Print tw_html object

Usage

## S3 method for class 'tw_html'
print(x, ...)

Arguments

Value

no return

Put a tiddler

Description

Put a tiddler

Usage

put_tiddler(
  title,
  text,
  type = c("text/vnd.tiddlywiki", "text/x-tiddlywiki", "text/x-markdown", "text/html",
    "text/plain", "application/json"),
  tags = NULL,
  fields = NULL,
  recipe = TW_OPTIONS("recipe")
)

Arguments

Value

No return value

Examples

## Not run: 
title <- "New tiddler"
text <- c("!! Section",
          "This is a new tiddler")
type <- "text/vnd.tiddlywiki"
tags <- c("Tag1", "Tag 2")
fields <- c("F1" = "V1", "F2" = "V2")
put_tiddler(title = title,
            text = text,
            type = type,
            tags = tags,
            fields = fields)

## End(Not run)

Read a TiddlyWiki Table into a Data Frame

Description

This function parses a table written in TiddlyWiki format and converts it into an R data frame. It can optionally treat the first row as a header.

Usage

read_table(table, header = TRUE)

Arguments

Value

A data frame containing the parsed table data.

Examples

table <- "|!Cell1 |!Cell2 |\n|Cell3 |Cell4 |"
df <- read_table(table, header = TRUE)
print(df)

Remove fields from tiddlers

Description

Remove fields from tiddlers

Usage

remove_fields(title, fields, recipe = TW_OPTIONS("recipe"))

Arguments

Value

no return value

Save ggplot into base64

Description

Save ggplot into base64

Usage

save_base64(plot, width = NULL, height = NULL, dpi = NULL, ...)

Arguments

Value

character string for base64 image

Examples

## Not run: 
library(ggplot2)
p <- cars |>
    ggplot() +
    geom_point(aes(speed, dist))
p |> save_base64()

## End(Not run)

Split tiddlywiki field into values

Description

Split tiddlywiki field into values

Usage

split_field(s)

Arguments

Value

an vector of values

Generate HTML Tabs with Dynamic Content

Description

This function creates a tabbed interface where each tab has dynamically generated content.

Usage

tabs(names, fun, groupname = .unique_name(), checked = 1, ...)

Arguments

Value

An 'htmltools::tagList' containing the tabbed interface.

Examples

## Not run: 
tab_labels <- c("Tab1", "Tab2", "Tab3")

tab_content_fun <- function(i, extra_text = "") {
    htmltools::tagList(
        htmltools::tags$p(paste("Content for tab:", tab_labels[i], extra_text)),
        htmltools::tags$img(src = paste0("plot_", i, ".png"), width = "100%")
    )
}

tabs(tab_labels, tab_content_fun, checked = 2, extra_text = "Additional details")

## End(Not run)

Format for converting from R Markdown to another tiddler markdown

Description

Format for converting from R Markdown to another tiddler markdown

Usage

tiddler_document(
  host = NULL,
  remote = FALSE,
  preview = FALSE,
  tags = NULL,
  fields = NULL,
  use_bookdown = FALSE,
  overwrite = FALSE,
  variant = "gfm",
  pandoc_args = "--wrap=none",
  ...
)

Arguments

Value

R Markdown output format to pass to render()

Examples

## Not run: 
library(rmarkdown)
render("input.Rmd")

## End(Not run)

Generate tiddler in json format

Description

Generate tiddler in json format

Usage

tiddler_json(
  title,
  text,
  type = c("text/vnd.tiddlywiki", "text/x-tiddlywiki", "text/x-markdown", "text/html",
    "text/plain", "application/json"),
  tags = NULL,
  fields = NULL,
  format = c("json", "list")
)

Arguments

Value

New tiddler in json format

Generate tiddler in json format

Description

Generate tiddler in json format

Usage

tiddler_json2(tiddler)

Arguments

Value

New tiddler in json format

Set or get options for my package

Description

Set or get options for my package

Usage

tw_options(...)

Arguments

Value

the default and modified options.

Supported options

The following options are supported host: Host of tiddlywiki recipe: Recipes are named lists of bags, ordered from lowest priority to highest bag: Bags have access controls that determines which users can read or write to them

Examples

tw_options(host = "http://127.0.0.1:8080/")

Reset global options for pkg

Description

Reset global options for pkg

Usage

tw_reset()

Value

the default options

Examples

tw_options()

Convert data.frame into table of TiddlyWiki

Description

Convert data.frame into table of TiddlyWiki

Usage

tw_table(df, collapse = "\n")

Arguments

Value

character string for table in TiddlyWiki

Examples

cars |>
dplyr::slice(1:10) |>
tw_table()

Create a tiddlywiki widget from htmlwidget

Description

Create a tiddlywiki widget from htmlwidget

Usage

tw_widget(widget, is_cat = FALSE)

Arguments

Value

a new tiddlywiki widget

Examples

library(leaflet)
## Not run: 
content <- paste(sep = "<br/>",
                 "<b><a href='http://www.samurainoodle.com'>Samurai Noodle</a></b>",
                 "606 5th Ave. S",
                 "Seattle, WA 98138"
)

widget <- leaflet() %>% addTiles() %>%
    addPopups(-122.327298, 47.597131, content,
                  options = popupOptions(closeButton = FALSE)
    )
tw_widget(widget)

## End(Not run)

backticks

Description

backticks for wikitext

Usage

wikitext_backticks_return(x)

Arguments

Value

By default this function outputs (see: cat) the result. Call the function ending in .return to catch the result instead.

Examples

wikitext_backticks('FOO')
wikitext_backticks_return('FOO')

Convert a Word File to Markdown with Optional Embedded Images

Description

This function converts a Word ('.docx') file to Markdown using Pandoc. Optionally, it embeds images as Base64 for a self-contained Markdown file.

Usage

word_to_md(
  docx_file,
  output_file = NULL,
  embed_images = FALSE,
  overwrite = FALSE
)

Arguments

Value

Saves a Markdown file (optionally with Base64-embedded images).

Examples

# Convert Word to Markdown without embedding images
## Not run: 
word_to_md("input.docx", "output.md", embed_images = FALSE)

# Convert and embed images as Base64
word_to_md("input.docx", "output_embedded.md", embed_images = TRUE)

## End(Not run)