Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I have an R function example in my documentation that needs to escape quotations:
#' @examples msearch("published_in:\"Journal of Ecology\"")
(Or at least I’m not clever enough to avoid escaping the quotation). While this command works correctly in R, the roxygenize/document function converts this to double escapes
msearch("published_in:\\"Journal of Ecology\\"")
in the .Rd file. How do I get around this?
As you’ve seen, the following line in an roxygen documentation block
is converted to this in an *.Rd file
on its way to becoming the following, in the various help file formats
I’m guessing that is what you actually want in the final product. As it does in so many other ways,
roxygenis simplifying the process of writing help files — in this case by letting you type\s where you’d like them to actually appear. It does so by escaping the\s (as you’d otherwise have to do), which is what you saw when you peeked into the*.Rdfile.