Function reference • letterblasteR

Project Gutenberg

The following functions help retrieve metadata and content from Project Gutenberg.

pg_metadata(): Download Project Gutenberg metadata for a single work

pg_files(): Extract file info from Project Gutenberg metadata

pg_download(): Download Project Gutenberg content

Text manipulation tools

The following functions help manipulate text for efficient, reproducible marking up of long texts.

diff_text(): Compare two character vectors

diff_css() diff_to_html() view_diff(): Formatting and viewing diffs

to_tidy_md(): Convert document to Pandoc's Markdown

Page layout tools

The following functions help plan a harmonious page layout for a work.

degrees(): Convert proportions to angles

name_ratios(): Match numeric proportions to named harmonious ratios

round_ratios(): Round proportions to nearest harmonious ratios

plot_layouts(): Visualize harmonious layouts

sample_text(): Generate sample text

estimate_line_length(): Estimate text width (measure)

fit_layouts_to_text_width(): Scale generic layouts

Package datasets

The package includes a few datasets to help make page layout decisions.

ratios: Harmonious ratios

layouts: Harmonious layouts

Developer tools

The following functions are intended to streamline common tasks for package developers. They are not exported for use by typical package users.

inst(): Find paths to package files (internal function)

dev(): Open an R file and its corresponding test file (internal function)

dev_check(): Run code quality checks (internal function)

dev_lint() dev_document() dev_spell_check() dev_build_site() dev_publish_vignettes() dev_coverage(): Helper functions called by dev_check()