Подтвердить что ты не робот

Roxygen2 вручную вставляет разрывы строк

У меня есть функция, которую я пытаюсь выполнить с помощью roxygen2:

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of:
#' "method1" - very long text here 
#' "method2" - very long text here
#' "method3" - very long text here
#' "method4" - very long text here 
#' "method5" - very long text here 
#' "method6" - very long text here 
#' "method7" - very long text here 
#' "method8" - very long text here 
#' "method9" - very long text here 
#' "method10" - very long text here 
myfun <- function (x, method){return(NULL)}

Эта функция имеет около 10 различных методов, каждая из которых имеет очень длинное описание. Мне нужна новая линия между каждым "методом", чтобы было легко быстро увидеть различные доступные методы.

Как написано, когда я вызываю roxygenize('mypackage'), вышеприведенный текст передается в одну строку.

Как вручную вставлять разрывы строк в документацию roxygen2?

4b9b3361

ОТВЕТЫ

Ответ 1

Это работает:

#' Name of function
#' 
#' Description
#' 
#' @param x The input data
#' @param method one of: \cr 
#' "method1" - very long text here \cr 
#' "method2" - very long text here \cr 
#' "method3" - very long text here \cr 
#' "method4" - very long text here \cr 
#' "method5" - very long text here \cr 
#' "method6" - very long text here \cr 
#' "method7" - very long text here \cr 
#' "method8" - very long text here \cr 
#' "method9" - very long text here \cr 
#' "method10" - very long text here \cr 
myfun <- function (x, method){return(NULL)}

Вот реальный пример в репо, где я использую \cr: https://github.com/trinker/SOdemoing/blob/master/R/FUN.R

Также комментарий @Gregor хорошо взят. Это будет выглядеть так:

#' @param method2 one of:
#' \itemize{
#'   \item method1 - very long text here 
#'   \item method2 - very long text here
#'   \item method3 - very long text here
#'   \item method4 - very long text here 
#'   \item method5 - very long text here 
#'   \item method6 - very long text here 
#'   \item method7 - very long text here 
#'   \item method8 - very long text here 
#'   \item method9 - very long text here 
#'   \item method10 - very long text here 
#' }

Здесь вы можете увидеть вывод для обоих:

enter image description here

Я создал репозиторий GitHub repo, SOdemoing, чтобы проверить такие вещи (более сложные вопросы и ответы, связанные с пакетом). См. FUN.R, где я тестирую оба подхода с помощью roxygen2, а затем справочное руководство, где я установил это снова (снова функция FUN.R).