Я пишу пакет R и создаю документацию, используя roxygen2. Я собираю пакет и документацию с помощью кнопки Build & Reload в RStudio. Согласно выходным данным RStudio, он использует devtools::document(roclets=c('rd', 'namespace'))
для компиляции документации.
Я хочу использовать тег @family
, чтобы связать несколько функций в документации, и здесь возникает моя проблема. Эта линия
#' @family functions returning some object
преобразуется в файле .Rd в следующий
\seealso{
Other functions.returning.some.object: \code{\link{test2}}
}
Мне не нужны точки между словами. У меня есть более старый пакет, в котором этого не происходит, даже если я перекомпилирую документацию в тех же настройках, что и новый пакет. Я не вижу принципиальной разницы между этим старым пакетом и моей новой попыткой.
Я написал очень простой тестовый пакет, в котором тоже возникает проблема. Он содержит один файл R (testpackage.R
):
#' Test function 1
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test1 <- function(x) {
x*x
}
#' Test function 2
#'
#' @param x a number
#'
#' @family functions returning some object
#' @family aggregate functions
#'
#' @export
test2 <- function(x) {
x*x*x
}
ОПИСАНИЕ файла
Package: testpackage
Type: Package
Title: Package for testing purposes
Version: 1.0
Date: 2015-05-21
Author: Me
Maintainer: Me <[email protected]>
Description: Package for testing purposes
License: GPL-3
NAMESPACE генерируется roxygen. Для документации test1.Rd
я получаю:
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/testpackage.R
\name{test1}
\alias{test1}
\title{Test function 1}
\usage{
test1(x)
}
\arguments{
\item{x}{a number}
}
\description{
Test function 1
}
\seealso{
Other aggregate.functions: \code{\link{test2}}
Other functions.returning.some.object: \code{\link{test2}}
}
с нежелательными точками в разделе \seealso
. Очевидно, что количество слов в теге @family
не имеет значения. Я пробовал заключать текст в кавычки, всевозможные скобки и т.д., но безрезультатно. Конечно, я мог бы отредактировать файлы Rd, но это упустило бы смысл использования roxygen2.
R CMD check
работает без предупреждений и ошибок на testpackage
.
Почему появляются эти точки? И как я могу избавиться от них?
@family
как минимум к двум функциям, чтобы иметь вывод. - person Stibu   schedule 23.01.2016