nie wyświetlaj dokumentu pomocy funkcji w pakiecie budynku R autorstwa roxygen2

Question

Używam devtools do budowania pakietu R, a niektóre funkcje NIE są zaprojektowane tak, aby były widoczne dla użytkowników końcowych. Ponieważ jednak funkcje te wymagają wywoływania kodów C przez .Call, muszę napisać @useDynLib powyżej funkcji automatycznego generowania plików .Rd. W ten sposób, gdy budowałem pakiet, nawet NIE zawierałem @export dla tych funkcji, pojawiają się one jednak w dokumencie pomocy ... Czy istnieje sposób na ich wyłączenie, nawet jeśli zostały one udokumentowane? Dzięki!

Answer 1

Zgodnie z uwagami Hadleya, użycie @keywords internal spowoduje, że funkcja będzie niewidoczna dla użytkowników końcowych. Szczegóły można znaleźć here na stronach wiki devtools.

Answer 2

Strona wiki powiązana z zaakceptowaną odpowiedzią nie obejmuje już tematu @keywords internal (stan na kwiecień 2016 r.). W przypadku, gdy jest to pomocne dla kogoś, aby zobaczyć przykład:

# multiplyBy3 
#' This is an example of an internal function called \code{multiplyBy3()} 
#' 
#' Sometimes you want internal functions as part of an R Package built with 
#' RStudio and roxygen2, but you don't want .Rd files created for them 
#' or to have them be visible in the help document following the build process 
#' 
#' @keywords internal 
#' 
#' @param base_num The number to multiply by three 
#' 
#' @import jsonlite 
#' 
#' @return Returns a numeric vector 
#' 
multiplyBy3 <- function(base_number) { 
    stopifnot(is.numeric(base_number)) 
    return(base_number * 3) 
} 

Kluczowe bitów: nie obejmują @export i zawierają @keywords internal