Ostrzeżenie R CMD: Funkcje / metody z użyciem w obiekcie dokumentacji… ale nie w kodzie
Piszę pakiet, ale jeden trwałyR CMD check
Ostrzeżenie uniemożliwia ukończenie pakietu i wysłanie go do CRAN. używamroxygen2
dla dokumentacji inline, chociaż prawdopodobnie nie jest to główna przyczyna błędu.
Jeśli wiesz, co zrobić, aby usunąć to ostrzeżenie, mogę całkiem wymyślić sposób jego wykonaniaroxygen2
.
Jak mogę usunąć ostrzeżenie Functions/methods with usage in documentation object ... but not in code
z moich czeków pakietowych?
TheR CMD check
ostrzeżenie:
* checking for code/documentation mismatches ... WARNING
Functions/methods with usage in documentation object 'names<-' but not in code:
names<-
Funkcja iroxygen
dokumentacja:
#' 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)
}
Powstały.rd
plik dokumentacji:
\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.
}
Sprawdziłem moją dokumentację z dokumentacją dlanames<-
w bazie R i wydaje się identyczny:
\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.}
Podobne pytanie (ale już wdrożyłem sugestię i nadal nie mam szczęścia):
Jak poprawnie udokumentować metodę S3 generycznego z innego pakietu, używając Roxygen?Gdzie się mylę? Jak mogę usunąć to ostrzeżenie z kontroli pakietów?