Given a code snippet is dont* or run, style it
Given a code snippet is dont* or run, style it
style_roxygen_example_snippet( code_snippet, transformers, is_dont, base_indention )
code_snippet |
A character vector with code to style. |
transformers |
Passed to |
is_dont |
Whether the snippet to process is a dontrun, dontshow, donttest segment or not. |
base_indention |
Integer scalar indicating by how many spaces the whole
output text should be indented. Note that this is not the same as splitting
by line and add a |
Styling involves splitting roxygen example code into segments, and segments
into snippets. This describes the process for input of
parse_transform_serialize_roxygen():
Splitting code into roxygen example code and other code. Downstream,
we are only concerned about roxygen code. See
parse_transform_serialize_roxygen().
Every roxygen example code can have zero or more
dontrun / dontshow / donttest sequences. We next create segments of roxygen
code examples that contain at most one of these. See
style_roxygen_code_example().
We further split the segment that contains at most one dont* sequence into
snippets that are either don* or not. See
style_roxygen_code_example_segment().
Finally, that we have roxygen code snippets that are either dont* or not,
we style them in style_roxygen_example_snippet() using
parse_transform_serialize_r().
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.