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

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 ofstringi).

Details

We use a slightly modified LaTeX Word Count algorithm taken from Kile 2.1.3, see http://kile.sourceforge.net/team.php for original contributors.

Examples

Run this code

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

if (stri_install_check(silent=TRUE))
stri_stats_latex(s)

# Stats for the preprint version of M. Gagolewski's book
# "Programowanie w jezyku R", Wydawnictwo Naukowe PWN, 2014.
# see http://rksiazka.rexamine.com
apply(
   sapply(
      list.files(path="~/Publikacje/ProgramowanieR/rozdzialy/",
         pattern=glob2rx("*.tex"), recursive=TRUE, full.names=TRUE),
      function(x)
      stri_stats_latex(readLines(x))
   ), 1, sum)

CharsWord CharsCmdEnvir    CharsWhite         Words          Cmds        Envirs
   718755        458403        281989        120202         37055          6119