R Предупреждение проверки CMD: функции / методы с использованием в объекте документации… но не в коде
Я пишу пакет, но один постоянныйR CMD check
предупреждение мешает мне закончить пакет и отправить его в CRAN. я используюroxygen2
для встроенной документации, хотя это, возможно, не является основной причиной ошибки.
Если вы знаете, что нужно сделать, чтобы удалить это предупреждение, я вполне могу найти способ сделать это, используяroxygen2
.
How can I remove the warning Functions/methods with usage in documentation object ... but not in code
from my package checks?
R CMD check
предупреждение:
* checking for code/documentation mismatches ... WARNING
Functions/methods with usage in documentation object 'names<-' but not in code:
names<-
Функция иroxygen
документация:
#' Updates names and variable.labels attribute of surveydata.
#'
#' @name names<-
#' @rdname names
#' @aliases names<- names<-.surveydata
#' @param x surveydata object
#' @param value New names
#' @method names<- surveydata
#' @usage names(x) <- value
"names<-.surveydata" <- function(x, value){
invisible(NULL)
}
Результирующий.rd
файл документации:
\name{names<-}
\alias{names<-}
\alias{names<-.surveydata}
\title{Updates names and variable.labels attribute of surveydata.}
\usage{
names(x) <- value
}
\arguments{
\item{x}{surveydata object}
\item{value}{New names}
}
\description{
Updates names and variable.labels attribute of
surveydata.
}
Я перепроверил мою документацию с документацией дляnames<-
в базе R, и это кажется идентичным:
\title{ The Names of an Object}
\name{names}
\alias{names}
\alias{names.default}
\alias{names<-}
\alias{names<-.default}
\keyword{attribute}
\description{Functions to get or set the names of an object.}
Связанный вопрос (но я уже реализовал предложение и все еще не повезло):
How to properly document a S3 method of a generic from a different package, using Roxygen?Where am I going wrong? How can I remove this warning from the package checks?