R Aviso de verificação do CMD: Funções / métodos com uso no objeto de documentação… mas não no código
Eu estou escrevendo um pacote, mas um persistenteR CMD check
aviso me impede de terminar o pacote e postar no CRAN. eu usoroxygen2
para documentação inline, embora isso possivelmente não seja a causa raiz do erro.
Se você sabe o que fazer para remover esse aviso, eu posso descobrir uma maneira de fazer isso usandoroxygen2
.
Como posso remover o aviso? Functions/methods with usage in documentation object ... but not in code
dos meus cheques de embalagem?
oR CMD check
Aviso:
* checking for code/documentation mismatches ... WARNING
Functions/methods with usage in documentation object 'names<-' but not in code:
names<-
A função eroxygen
documentação:
#' 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)
}
O resultado.rd
arquivo de documentação:
\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.
}
Eu chequei minha documentação com a documentação paranames<-
na base R, e parece idêntico:
\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.}
Pergunta relacionada (mas já implementei a sugestão e ainda não tenho sorte):
Como documentar adequadamente um método S3 de um genérico de um pacote diferente, usando o Roxygen?Onde eu estou errando? Como posso remover esse aviso das verificações de pacote?