Skip to contents

default_on marks the steps the "standard" preset runs. Steps are always applied "early" stage first, whatever order you list them in.

Usage

gr_cleaners()

Value

A data frame with name, stage, scope, default_on and description.

Examples

gr_cleaners()
#>                   name stage    scope default_on
#> 1             captions early    block      FALSE
#> 2               emails early    block      FALSE
#> 3      headers_footers early document      FALSE
#> 4          hyphenation early    block       TRUE
#> 5         page_numbers early    block       TRUE
#> 6           references early document      FALSE
#> 7                 urls early    block      FALSE
#> 8           ascii_only  late    block      FALSE
#> 9  collapse_whitespace  late    block       TRUE
#> 10       control_chars  late    block       TRUE
#> 11           ligatures  late    block       TRUE
#> 12           lowercase  late    block      FALSE
#> 13      remove_numbers  late    block      FALSE
#> 14  remove_punctuation  late    block      FALSE
#>                                                                                                      description
#> 1                               Drop figure/table caption lines (OFF by default: destroys table-heavy documents)
#> 2                                                                                         Remove email addresses
#> 3                                                        Drop short lines repeated on many pages (running heads)
#> 4                                       Rejoin words split across line breaks by PDF layout ('mito-\\nchondria')
#> 5                    Drop decorated page-number lines ('Page 4', '- 12 -', '[12]', '12.'); bare numbers are kept
#> 6                                Drop a trailing bibliography, from a References/Bibliography heading to the end
#> 7                                                        Remove URLs (OFF by default: URLs are often the answer)
#> 8                                                   Transliterate to ASCII (drops accents and non-Latin scripts)
#> 9  Collapse runs of spaces/tabs and 2+ consecutive blank lines, and trim block edges; preserves paragraph breaks
#> 10                                           Strip control and zero-width characters that survive PDF extraction
#> 11                                                Expand typographic ligatures and normalise smart quotes/dashes
#> 12                                                   Lowercase everything (loses proper-noun and acronym signal)
#> 13      Replace every digit with a space. OFF by default: this makes figures, dates and percentages unanswerable
#> 14                                 Replace punctuation with spaces. OFF by default: destroys sentence boundaries
# The steps the "standard" preset runs:
subset(gr_cleaners(), default_on)$name
#> [1] "hyphenation"         "page_numbers"        "collapse_whitespace"
#> [4] "control_chars"       "ligatures"