2
Интересно, как следует документировать, что для функции требуется вторая функция или пакет. Существуют ли определенные теги для этого или я должен просто сказать это описание функции?Roxygen2 document зависимость функции
#' @title Downloads stuff from that place
#'
#' @details Maybe document the dependency here?
#'
#' @param stuff Thing to be downloaded
#' @param save_to Where to place the thing
#' @return Nothing. Called for its side effect
download_stuff = function(stuff, save_to) {
require('RCurl') # How do document this?
# thing = download stuff using RCurl
# write thing to save_to
}
'' @seealso, вероятно, ваш лучший выбор – kdopen
На самом деле, я немного неправильно. Вероятно, зависимость внутри пакета лучше всего делать с помощью ∘seealso @ seealso. Зависимость requirerequire применяется ко всему вашему пакету, поэтому его следует обрабатывать в метаданных для пакета. Я считаю, что обычно считается неправильной формой использования requirerequire внутри функции .... Предполагая, что вы создаете новый пакет :( –
kdopen
В руководстве R Extensions указано, что 'require()' и 'library()' should не следует использовать в пакете. Если вы планируете отправляться в CRAN, вам нужно добавить RCurl в файл NAMESPACE –