The goal of namer is to name the chunks of R Markdown files. It’s your safety net when you’ve (willingly) forgotten to name most chunks of all R Markdown files in a folder.
namer does not give meaningful labels to your chunks, but it gives them labels that won’t change depending on their position like the automatic
knitr:::unnamed_chunk function does when knitting. So you can e.g. shuffle your chunks and not loose their cache, or more easily debug over a whole folder!
For context about why you should name your R Markdown chunks, read this blog post.
This is a basic example which shows you how to solve a common problem. The “test” folder first contains R Markdown files with unnamed chunks. After running
name_dir_chunks, they’re all named, with names using the filenames as basis.
name_chunks() for use on a single R Markdown file; and
unname_chunks() to unname all chunks of a single R Markdown file as well as
unname_dir_chunks() to unname all chunks of all R Markdown files in a directory, which can be useful when cleaning your chunk labels.
unname_chunks() unnames all chunks with exception of the ‘setup’ chunk. By using the argument
chunk_name_prefix one can indicate the prefix of the labels that will be unnamed. Useful when one refers to a label by using chunk option
ref.label so that it is inconvenient when that labeel is unnamed. By setting
chunk_name_prefix equal to ‘the filename with extension stripped’ followed with a ‘-’ (dash) only the labels generated by
name_chunks() will be unnamed.
If you’re working with RStudio, installing the package will have installed an addin for labelling chunks of any R Markdown document you select.
namer, please check the edits before pushing them to your code base. Such automatic chunk labelling is best paired with version control.