comment_out: Comment out codes based on their languages.
In atusy/chunkhooks: Chunk Hooks for 'R Markdown'

Description Usage Arguments See Also Examples

View source: R/hook_title_comment.R

Comment out codes based on their languages.

1	comment_out(x, engine, extra_syntax = character(0L))

`x`	A character vector
`engine`	A string that defines the engine of the `x`. See `names(comment_syntax)` for the predefined engines.
`extra_syntax`	A named character vector which defines extra syntax to comment out. Each values should contain `%s` which is the placeholder to insert `x`. If definitions collides among `comment_syntax` and `extra_syntax`, then the latter has priority.

comment_syntax()

# Default behaviors
comment_out("R language", "R")
comment_out("Python language", "python")

# A customized behavior
comment_out(
  "Python language",
  "python",
  extra_syntax = c("python" = '"""%s"""')
)