Skip to contents

Read

Ingest and tidy literary text.

syn_read_text()
Read literary text into a tidy tibble
syn_example_text()
Bundled example passages

Score

Extract the prosody score that drives everything downstream.

syn_score()
Score literary text into a prosody_score
is_prosody_score()
Test whether an object is a prosody_score

Paint

Render the score as a generative image.

syn_paint()
Render a prosody_score as a generative still image
syn_animate()
Render an evolving animation across the text's arc (optional)

Play

Render the score as synchronized audio.

syn_play()
Render a prosody_score as a synchronized audio waveform
syn_write_wav()
Write a prosody_score's audio to a .wav file
syn_play_gm()
Optional richer score/audio via the gm + MuseScore backend

Palette & theme

Extract colours and ggplot2 themes from any source.

syn_palette()
Extract a colour palette from any supported source
syn_theme()
Build a ggplot2 theme from a palette or any palette source
is_syn_palette()
Test whether an object is a syn_palette

Media interchange

The shared currency passed between functions.

as_syn_media()
Wrap a media object in the suite interchange container
is_syn_media()
Test whether an object is a syn_media container
media_type() media_content()
Accessors for syn_media content and type

Optional assist (rim)

LLM, Python, and CLI extensions; all degrade gracefully.

syn_interpret()
Interpret a prosody_score in prose using a local LLM
syn_suggest()
Suggest palette or tempo tweaks via a local LLM (advisory only)
syn_llm_condense()
Summarise or condense long text before scoring (opt-in, mutates input)
syn_py_features()
Enrich a prosody_score with optional Python-computed features
syn_export_video()
Export a synesthR piece as video (reserved for a future release)

App

syn_run_app()
Launch the synesthR demo Shiny app