Bagian sewenang-wenang di dokumen roxygen

93

Cara kerja Roxygen adalah bahwa baris pertama adalah \title, semua yang lain ada di \details, dan kemudian @fooarahan menangani hal-hal itu. Tapi dokumentasi R lebih kaya dari itu. Saya dapat memiliki "\section{Llamas}{Are they ungulates?}"dalam file .Rd.

Tapi saya tidak bisa membuat Roxygen melakukan apa pun selain membungkus semuanya dalam \ detail. Apakah saya melewatkan sesuatu?

Saya memiliki solusi hacky, yang tetap tak tertandingi }sebelum saya \section. Ini kemudian mengakhiri \detailsbagian. Saya kemudian tidak boleh mengakhirinya }, karena roxygen menempel pada seseorang dalam berpikir menutupnya \details. Eeeeeurrrrrrrrgh.

r roxygen Spacedman
sumber
2
Pertanyaan yang bagus. Saya curiga Anda benar bahwa ini tidak dapat dilakukan saat ini. Tapi Hadley Wickham baru-baru ini menyebutkan bahwa dia memegang kunci perkembangan roxygen di masa depan, jadi saya berharap sesuatu yang luar biasa akan muncul dalam waktu dekat.
Andrie
4
Bergantung pada seberapa dalam yang Anda inginkan, Anda mungkin menawarkan untuk membantu Hadley dengan apa yang dia lakukan. Saya tahu pekerjaannya luar biasa, tapi bagaimanapun, 'Vell, dia hanya pria zis, Anda tahu?'. Anda mungkin ingin membaca dengan teliti kode yang telah diterbitkan Hadley di github github.com/hadley/roxygen dan mungkin mengiriminya email dan bertanya padanya ...
PaulHurleyuk
1
Tentu. Aku juga pernah melihat Hadley di sini, jadi dia mungkin sadar. Awalnya kupikir aku melewatkan sesuatu di dokumen, seperti arahan "@section Llamas" atau serupa.
Spacedman
6
Saya benar-benar menyukai llama. Itu semuanya.
JD Long
3
Lihat @sectiontag di roxygen2
hadley

Jawaban:

22

Dukungan ini telah ditambahkan (setidaknya dalam roxygen2). Anda hanya perlu menambahkan @section Llamas:dan kemudian apa pun setelah itu sampai petunjuk baru terpenuhi akan ada di bagian Llamas. Berikut ini contohnya

#' Llama llama llama
#' 
#' More about llamas
#' 
#' @section Llamas:
#' Are they ungulates?
#' 
#' @section Not llamas:
#' This section is not about llamas.  It is not very interesting.
#' 
#' @param notused A parameter that isn't used at all!
#' @export
llama <- function(notused){
    return("LLAMA LLAMA LLAMA")
}

yang memberikan berikut ini untuk file .Rd

\name{llama}
\alias{llama}
\title{Llama llama llama}
\usage{
  llama(notused)
}
\arguments{
  \item{notused}{A parameter that isn't used at all!}
}
\description{
  More about llamas
}
\section{Llamas}{
  Are they ungulates?
}

\section{Not llamas}{
  This section is not about llamas.  It is not very
  interesting.
}
Dason
sumber