Hide navigation sidebar
Hide table of contents sidebar
Back to top
Edit this page
Toggle table of contents sidebar

# stri_stats_latex: Statistics for a Character Vector Containing LaTeX Commands

## Description

This function gives LaTeX-oriented statistics for a character vector, e.g., obtained by loading a text file with the `readLines` function, where each text line is represented by a separate string.

## Usage

    stri_stats_latex(str)

## Arguments

`str` | character vector to be aggregated

## Details

We use a slightly modified LaTeX Word Count algorithm implemented in Kile 2.1.3, see https://kile.sourceforge.io/team.php for the original contributors.

## Value

Returns an integer vector with the following named elements:

1. `CharsWord` - number of word characters;

2. `CharsCmdEnvir` - command and words characters;

3. `CharsWhite` - LaTeX white spaces, including { and } in some contexts;

4. `Words` - number of words;

5. `Cmds` - number of commands;

6. `Envirs` - number of environments;

7. … (Other stuff that may appear in future releases of stringi).

## Author(s)

Marek Gagolewski and other contributors

## See Also

The official online manual of stringi at https://stringi.gagolewski.com/

Gagolewski M., stringi: Fast and portable character string processing in R, Journal of Statistical Software 103(2), 2022, 1-59, doi:10.18637/jss.v103.i02

Other stats: `stri_stats_general()`

## Examples

    s <- c('Lorem \\textbf{ipsum} dolor sit \\textit{amet}, consectetur adipisicing elit.',
           '\\begin{small}Proin nibh augue,\\end{small} suscipit a, scelerisque sed, lacinia in, mi.',
           '')
    stri_stats_latex(s)
    ##     CharsWord CharsCmdEnvir    CharsWhite         Words          Cmds
    ##            96            38            27            18             2
    ##        Envirs
    ##             1