example - roxygen importfrom

Secciones arbitrarias en documentos roxygen

Question

La forma en que Roxygen parece funcionar es que la primera línea es el /title , todo lo demás está en /details , y luego todas @foo directivas @foo manejan esas cosas. Pero la documentación de R es más rica que eso. Puedo tener "/section{Llamas}{Are they ungulates?}" En archivos .Rd.

Pero no puedo hacer que Roxygen haga nada más que envolverlo todo en detalles. ¿Me estoy perdiendo de algo?

Tengo una solución hacky, que es pegar un } sin precedentes antes de mi /section . Esto luego finaliza la sección /details . Entonces no tengo que poner un final } , porque roxygen le pega a uno al pensar que está cerrando los /details . Eeeeeurrrrrrrrgh.

Answer 1

Este soporte ha sido agregado (al menos en roxygen2). Solo necesita agregar @section Llamas: y luego cualquier cosa hasta que se cumpla una nueva directiva estará en la sección Llamas. Aquí hay un ejemplo

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

que da lo siguiente para el archivo .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.
}