Package 'rtiddlywiki' reference manual

Title:	R Interface for 'TiddlyWiki'
Description:	'TiddlyWiki' is a unique non-linear notebook for capturing, organising and sharing complex information. 'rtiddlywiki' is a R interface of 'TiddlyWiki' <https://tiddlywiki.com> to create new tiddler from Rmarkdown file, and then put into a local 'TiddlyWiki' node.js server if it is available.
Authors:	Bangyou Zheng
Maintainer:	Bangyou Zheng <[email protected]>
License:	MIT + file LICENSE
Version:	0.3.0
Built:	2025-03-04 05:25:19 UTC
Source:	https://github.com/byzheng/rtiddlywiki

Delete a tiddler

Description

Delete a tiddler

Usage

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

Arguments

`title`	title of the tiddler to retrieve
`bag`	string defining which recipe to write to (optional, defaults to "default")

Value

no return values

Examples

## Not run: 
delete_tiddler("GettingStarted")

## End(Not run)
## Not run: 
delete_tiddler("GettingStarted")

## End(Not run)

Get a tiddler

Description

Get a tiddler

Usage

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

Arguments

`title`	title of the tiddler to retrieve
`recipe`	string defining which recipe to read from (optional, defaults to "default")

Value

tiddler information in JSON format

Examples

## Not run: 
get_tiddler("GettingStarted")

## End(Not run)
## 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"))
get_tiddlers(filter = NULL, exclude = NULL, recipe = TW_OPTIONS("recipe"))

Arguments

`filter`	filter identifying tiddlers to be returned (optional, defaults to "[all[tiddlers]!is[system]sort[title]]")
`exclude`	comma delimited list of fields to excluded from the returned tiddlers (optional, defaults to "text")
`recipe`	string defining which recipe to read from (optional, defaults to "default")

Value

all tiddlers information in JSON format

Examples

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

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

## End(Not run)

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")
)
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

`title`	tiddler title
`text`	tiddler text
`type`	tiddler type
`tags`	tiddler tags which is merged with existing tags
`fields`	a named vector for tiddler fields which is merged with existing tags
`recipe`	string defining which recipe to write to (optional, defaults to "default")

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)
## 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)
read_table(table, header = TRUE)

Arguments

`table`	A character string representing the TiddlyWiki table.
`header`	A logical value indicating whether the first row should be treated as column headers. Default is TRUE.

Value

A data frame containing the parsed table data.

Examples

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

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

Save ggplot into base64

Description

Save ggplot into base64

Usage

save_base64(plot, width = 5, height = 4, dpi = 300)
save_base64(plot, width = 5, height = 4, dpi = 300)

Arguments

`plot`	object for ggplot2
`width`	image width
`height`	image height
`dpi`	image resolution

Value

character string for base64 image

Examples


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

Split tiddlywiki field into values

Description

Split tiddlywiki field into values

Usage

split_field(s)
split_field(s)

Arguments

s

a string

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, ...)
tabs(names, fun, groupname = .unique_name(), checked = 1, ...)

Arguments

`names`	A character vector of tab labels.
`fun`	A function that generates the content for each tab. It must take an index ('i') as the first argument.
`groupname`	A unique string to group the radio inputs (default is generated automatically).
`checked`	The index of the tab that should be pre-selected (default is '1').
`...`	Additional arguments passed to 'fun'.

Value

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

Examples

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")

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")

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,
  tags = NULL,
  fields = NULL,
  use_bookdown = FALSE,
  overwrite = FALSE,
  variant = "gfm",
  pandoc_args = "--wrap=none",
  ...
)
tiddler_document(
  host = NULL,
  tags = NULL,
  fields = NULL,
  use_bookdown = FALSE,
  overwrite = FALSE,
  variant = "gfm",
  pandoc_args = "--wrap=none",
  ...
)

Arguments

`host`	the host of tiddlywiki web server
`tags`	tiddler tags
`fields`	a named vector for tiddler fields
`use_bookdown`	logical. Use bookdown to generate markdown file.
`overwrite`	whether to overwrite the existing tiddler.
`variant`	variant for md_document
`pandoc_args`	pandoc_args for md_document
`...`	Other argument pass to md_document

Value

R Markdown output format to pass to render()

Examples

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

## End(Not run)
## 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")
)
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

`title`	tiddler title
`text`	tiddler text
`type`	tiddler type
`tags`	a vector for tiddler tags
`fields`	a named vector for tiddler fields.
`format`	export format as json or list

Value

New tiddler in json format

Generate tiddler in json format

Description

Generate tiddler in json format

Usage

tiddler_json2(tiddler)
tiddler_json2(tiddler)

Arguments

tiddler

A list for new tiddler

Value

New tiddler in json format

Set or get options for my package

Description

Set or get options for my package

Usage

tw_options(...)
tw_options(...)

Arguments

...

Option names to retrieve option values or [key]=[value] pairs to set options.

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/")
tw_options(host = "http://127.0.0.1:8080/")

Reset global options for pkg

Description

Reset global options for pkg

Usage

tw_reset()
tw_reset()

Value

the default options

Examples

tw_options()
tw_options()

Convert data.frame into table of TiddlyWiki

Description

Convert data.frame into table of TiddlyWiki

Usage

tw_table(df, collapse = "\n")
tw_table(df, collapse = "\n")

Arguments

`df`	data.frame object
`collapse`	an optional character string to separate the results.

Value

character string for table in TiddlyWiki

Examples

cars |>
dplyr::slice(1:10) |>
tw_table()
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)
tw_widget(widget, is_cat = FALSE)

Arguments

`widget`	an object of htmlwidget
`is_cat`	whether to show results on screen

Value

a new tiddlywiki widget

Examples

library(leaflet)
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)
library(leaflet)
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)

backticks

Description

backticks for wikitext

Usage

wikitext_backticks_return(x)
wikitext_backticks_return(x)

Arguments

`x`	character vector

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')
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
)
word_to_md(
  docx_file,
  output_file = NULL,
  embed_images = FALSE,
  overwrite = FALSE
)

Arguments

`docx_file`	Path to the input Word file.
`output_file`	Path to the final Markdown output file. If null, the original file name.
`embed_images`	Logical. If 'TRUE', all images will be embedded as Base64. Default is 'FALSE'.
`overwrite`	Logical. If 'TRUE', Output file is overwrote. Default is 'FALSE'

Value

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

Examples

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

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

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

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

## End(Not run)

Package 'rtiddlywiki'

Help Index

Delete a tiddler

Description

Usage

Arguments

Value

Examples

Get server status

Description

Usage

Value

Get a tiddler

Description

Usage

Arguments

Value

Examples

Get all tiddlers

Description

Usage

Arguments

Value

Examples

Put a tiddler

Description

Usage

Arguments

Value

Examples

Read a TiddlyWiki Table into a Data Frame

Description

Usage

Arguments

Value

Examples

Remove fields from tiddlers

Description

Usage

Arguments

Value

Save ggplot into base64

Description

Usage

Arguments

Value

Examples

Split tiddlywiki field into values

Description

Usage

Arguments

Value

Generate HTML Tabs with Dynamic Content

Description

Usage

Arguments

Value

Examples

Format for converting from R Markdown to another tiddler markdown

Description

Usage

Arguments

Value

Examples

Generate tiddler in json format

Description

Usage

Arguments

Value

Generate tiddler in json format

Description

Usage

Arguments

Value

Set or get options for my package

Description

Usage

Arguments

Value

Supported options