Сборка пакетов R - ошибка: пример требует значения

Question

Когда я собираю свой пакет, я получаю эту ошибку. Можете ли вы помочь мне узнать, как избежать этой ошибки?

#' Square a number
#' 
#' Takes in any numeric value and squares it
#' @param x A value to be squared
#' @return The square of the input
#' @export
#' @example 
square <- function(x)
{
  return(x^2)
}

Вот ошибка, когда я нажимаю сборку:

==> roxygenize('.', roclets=c('rd', 'collate', 'namespace'))

* checking for changes ... ERROR

Error : example requires a value

Answer 1

Попробуйте следующее:

#' @title
#' Square a number
#' 
#' @description
#' Takes in any numeric value and squares it
#'
#' @param x A value to be squared
#' @return The square of the input
#'
#' @export
#' @examples
#' square(2) # 2 squared
square <- function(x)
{
  return(x^2)
}

Кроме того, убедитесь, что вы играете с последними roxygen2 пакет.