Создание пакета devtools roxygen и документация rd

Я удивлен, что @hadley говорит не использовать package.skeleton в своем комментарий. Я бы использовал package.skeleton, добавил блоки комментариев roxygen, затем удалил все файлы в каталоге «man» и запустил roxygenize. Однако, поскольку Хэдли говорит "Не-е-ет", вот минимум, необходимый для создания пакета, который проходит проверку R CMD и экспортирует ваши функции.

Создайте каталог с именем «package1». В этом каталоге создайте файл с именем DESCRIPTION и поместите в него это (отредактируйте его соответствующим образом, если хотите):

ОПИСАНИЕ

Package: package1
Type: Package
Title: What the package does (short line)
Version: 0.0.1
Date: 2012-11-12
Author: Who wrote it
Maintainer: Who to complain to <[email protected]>
Description: More about what it does (maybe more than one line)
License: GPL

Теперь создайте каталог с именем «R» и добавьте файл для каждой функции (или вы можете поместить обе свои функции в один и тот же файл, если хотите). Я создал 2 файла: fun1.R и fun2.R

fun1.R

#' fun1
#' @param x numeric
#' @export
fun1 <- function(x){
    rnorm(100*x)
}

fun2.R

#' fun2
#' @param y numeric
#' @export
fun2 <- function(y){
    rnorm(200*y)
}

Теперь вы можете roxygenize свой пакет

R> library(roxygen2)
Loading required package: digest
R> list.files()
[1] "package1"
R> roxygenize("package1")
Updating collate directive in  /home/garrett/tmp/package1/DESCRIPTION 
Updating namespace directives
Writing fun1.Rd
Writing fun2.Rd

Поскольку вы упомянули devtools в заголовке своего вопроса, вы можете использовать функции build и install из devtools.

build('package1')
install('package1')

Или вы можете выйти из R и использовать инструменты, поставляемые с R, для сборки/проверки/установки.

$ R CMD build package1
$ R CMD check package1_0.0.1.tar.gz
$ R CMD INSTALL package1_0.0.1.tar.gz 

Теперь снова запустите R, чтобы использовать новый пакет.

$ R --vanilla -q

library(package1)
fun1(20)
fun2(20)

Но выяснение минимальных требований вряд ли сильно поможет вам (или пользователям вашего пакета). Вам было бы намного лучше изучить один из множества пакетов, использующих roxgen2.

Вот улучшенная версия файла fun1.R, которая по-прежнему не использует все теги roxygen, которые могла бы использовать, но намного лучше, чем минимальный минимум.

Модифицированный fun1.R

#' fun1
#'
#' This is the Description section
#'
#' This is the Details section
#'
#' @param x numeric. this is multiplied by 100 to determine the length of the returned vector
#' @return a numeric vector of random deviates of length \code{100 * x}
#' @author your name
#' @seealso \code{\link{fun2}}
#' @examples
#' fun1(2)
#' length(fun1(20))
#' @export
fun1 <- function(x){
    rnorm(100*x)
}

Намного позже. Вы можете позволить RoxygenReady подготовить свои функции с минимальным скелетом аннотации Roxygen. В основном это приводит вас от ваших двух входных функций к ответу GSee, который является вводом Roxygen2.