Home
Reading
Searching
Subscribe
Sponsors
Statistics
Posting
Contact
Spam
Lists
Links
About
Hosting
Filtering
Features Download
Marketing
Archives
FAQ
Blog
 
Gmane
From: =?ISO-8859-1?Q?Dar=F3czi_Gergely?= <daroczi.gergely-zo1AGQZcLMuT9ig0jae3mg <at> public.gmane.org>
Subject: Re: Problem with backslashes in default arguments for usage
Newsgroups: gmane.comp.lang.r.roxygen
Date: Monday 6th December 2010 00:37:26 UTC (over 5 years ago)
Dear list members,

I have just read a thread (
http://lists.r-forge.r-project.org/pipermail/roxygen-devel/2009-August/000077.html
) from a year ago about "problem with backslashes" with roxygen, after I
was
searching for an asnwere for my problem.
I have some functions with default parameter set to '\n', e.g.:

   lineCount <- function(text, sep='\n') {
       ...
   }

Which purpose is to count new line ('\n') characters in a string.
The problem is that R CMD check gives a warning about:

Codoc mismatches from documentation object 'lineCount':
lineCount
  Code: function(text, sep = "\n")
  Docs: function(text, sep = " ")
  Mismatches in argument default values:
    Name: 'sep' Code: "\n" Docs: " "

The problem seems to me that caused by writing to the Rd file (writing to
standard LaTeX files always requires to double escape characters for some
purpose, e.g.: \\newline  - as I experienced).
If I put an extra backslash to the separator, like:

   lineCount <- function(text, sep='\\n') {
       ...
   }

The problem still presists, as in the code it looks like '\\n', but in the
docs it looks '\n'.
Is there an easy solution for my problem? May be an extra tag in Roxygen
which could define how to write the function's params to the Rd file?
Sorry if asked too obvious question, but I am lost after google-ing for a
while.

Best regards,
Gergely Daróczi
 
CD: 3ms