rmdwc (version 0.1.1)

rmdcount: Word, character and non-whitespace characters count

Description

Counts words, characters and non-whitespace characters in R Markdown files.

Usage

rmdcount(files = NULL, space = "[[:space:]]", word = "[[:space:]]+")

Arguments

files

character: file name(s)

space

character: pattern to split a text at spaces (default: '[[:space:]]')

word

character: pattern to split a text at word boundaries (default: '[[:space:]]+')

Value

a data frame wthe following elements

file

basename of a file

words

number of words including code chunks

chars

number of characters including code chunks

nonws

number of non-whitespace characters including code chunks

words_chunk

number of words excluding code chunks

chars_chunk

number of characters excluding code chunks

nonws_chunk

number of non-whitespace characters excluding code chunks

path

path of a file

Details

It uses the following approaches to detect words, characters and non-whitespace characters.

words

strsplit(rmd, word)[[1]] with word equal to '[[:space:]]+'

characters

strsplit(rmd, '')[[1]]

non-whitespace characters

strsplit(gsub(space, '', rmd), '')[[1]] with space equal to '[[:space:]]'

This is repeated for the text without code chunks. Code chunks are deleted with gsub('```\\{.*?```', '', rmd).

Examples

# NOT RUN {
files <- system.file('rmarkdown/rstudio_pdf.Rmd', package="rmdwc")
rmdcount(files)
# use of rmdcount() in a R Markdown document 
if (interactive()) {
  file.edit(files) # SAVE(!) the file and knit it 
}
# }