I use Roxygen to generate Rd files of my packages under development, but I have some problems with 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.
Проблема в том, что проверка R CMD выдает предупреждение о:
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: " "
Мне кажется, что проблема вызвана записью в файл Rd (запись в стандартные файлы LaTeX через cat ()
всегда требует двойного escape-символа для какой-то цели, например: \\ newline
- как я испытал).
Если я добавлю к разделителю дополнительную обратную косую черту, например:
lineCount <- function(text, sep='\\n') {
...
}
Проблема все еще существует, так как в коде она выглядит как '\\ n'
, но в документах (файлы Rd) она выглядит '\ n'
.
Есть ли простое решение моей проблемы? Может быть, это дополнительный тег в Roxygen, который мог бы определять, как записывать параметры функции в файл Rd? Извините, если задали слишком очевидный вопрос, но я на какое-то время потерялся после работы в Google.
История: http://permalink.gmane.org/gmane.comp.lang.r.roxygen/24
ОБНОВЛЕНИЕ : используйте roxygen2 !