2015-01-03 3 views
1

Я хочу документировать несколько функций на одной странице справки, используя roxygen2, но я хочу иметь только один псевдоним на странице справки i.e General, указанной в индексе. Является ли это возможным?Опустить псевдонимы в roxygen2

Пример:

#' General functions 
#' @name General 
NULL 

#' @rdname Foo 
foo <- function() NULL 

#' @rdname Bar 
bar <- function() NULL 

Как опустить foo и bar псевдонимы из индекса пакета документации?

Реальный пример из жизни здесь бы одного Arithmetic псевдонима для документирования различных функций (+, -, /, * и т.д.).

ответ

0

Я нашел ответ сам: вы просто не экспортируют те, и сделать функцию-независимой документации страницы:

#' General functions 
#' 
#' @usage 
#' foo() 
#' bar() 
#' 
#' @name General 
NULL 

#' @export 
foo <- function() NULL 

#' @export 
bar <- function() NULL 

 Смежные вопросы

  • Нет связанных вопросов^_^