Roxygen belgelerinde keyfi bölümler


94

Yolu Roxygen çalışması gibi görünüyor ilk satırı olmasıdır \title, her şey olduğu \detailsve daha sonra herhangi @foodirektifler o şeyleri ele. Ancak R dokümantasyonu bundan daha zengindir. "\section{Llamas}{Are they ungulates?}".Rd dosyalarına sahip olabilirim .

Ama Roxygen'in hepsini ayrıntılara sığdırmaktan başka bir şey yapmasını sağlayamıyorum. Bir şey mi kaçırıyorum?

Ben eşsiz bir sopa olan bir hacky çözüm var }ne biz önce \section. Bu daha sonra \detailsbölümü bitirir . O zaman bir son }koymamalıyım, çünkü roxygen \details,. Eeeeeurrrrrrrrgh.


2
Harika soru. Bunun şu anda yapılamayacağı konusunda haklı olduğunuzdan şüpheleniyorum. Ancak Hadley Wickham kısa süre önce roxygen'in gelecekteki gelişiminin anahtarını nasıl elinde tuttuğundan bahsetti, bu nedenle yakın gelecekte şaşırtıcı bir şeyin ortaya çıkacağını umuyorum.
Andrie

4
Ne kadar derinlemesine bilgi almak istediğinize bağlı olarak, Hadley'e yaptığı işte yardım etmeyi teklif edebilirsiniz. Çalışmasının harika olduğunu biliyorum, ama sonuçta, 'Vell, o sadece zis adamı, biliyor musun?' Hadley'nin github.com/hadley/roxygen adresinde yayınladığı kodu incelemek ve belki ona bir e-posta gönderip sormak isteyebilirsiniz ...
PaulHurleyuk

1
Elbette. Hadley'i de burada gördüm, bu yüzden farkında olabilir. İlk başta belgelerde bir "@section Llamas" yönergesi veya benzeri bir şeyi kaçırdığımı düşündüm.
Spacedman

6
Lamaları kesinlikle severim. Hepsi bu.
JD Long

3
@sectionRoxygen2 içindeki etikete bakın
hadley

Yanıtlar:


23

Bu destek eklendi (en azından roxygen2'de). Sadece eklemeniz gerekir @section Llamas:ve yeni bir direktif karşılanana kadar bundan sonraki her şey bir Llamas bölümünde olacaktır. İşte bir örnek

#' 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")
}

.Rd dosyası için aşağıdakileri verir

\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.
}
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.