ส่วนตามอำเภอใจในเอกสาร roxygen


94

วิธีที่ดูเหมือนว่าRoxygenจะได้ผลคือบรรทัดแรกคือ\titleสิ่งอื่น ๆ ที่อยู่ใน\detailsนั้นและจากนั้น@fooคำสั่งใด ๆ ก็จัดการกับสิ่งเหล่านั้น แต่เอกสาร R นั้นยิ่งใหญ่กว่านั้น ฉันสามารถมี"\section{Llamas}{Are they ungulates?}"ในไฟล์. RD

แต่ฉันไม่สามารถให้ Roxygen ทำอย่างอื่นได้นอกจากห่อรายละเอียดทั้งหมด ฉันพลาดอะไรไปรึเปล่า?

ฉันมีวิธีการแก้ปัญหา hacky ซึ่งก็คือการติดตรงกันก่อนของฉัน} \sectionจากนั้นจะสิ้นสุด\detailsส่วนนี้ จากนั้นฉันต้องไม่ลงท้ายด้วย}เพราะ roxygen เกาะติดหนึ่งในการคิดว่ามันจะปิด\details. อีนี่เออร์รรรรรรรรร


2
คำถามที่ยอดเยี่ยม ฉันสงสัยว่าคุณถูกต้องที่ไม่สามารถทำได้ในขณะนี้ แต่ Hadley Wickham เพิ่งกล่าวว่าเขาถือกุญแจสำคัญในการพัฒนา roxygen ในอนาคตได้อย่างไรดังนั้นฉันจึงหวังว่าสิ่งที่น่าอัศจรรย์จะปรากฏขึ้นในอนาคตอันใกล้นี้
Andrie

4
คุณอาจเสนอตัวช่วย Hadley ในสิ่งที่เขากำลังทำอยู่ทั้งนี้ขึ้นอยู่กับว่าคุณต้องการรับข้อมูลเชิงลึกเพียงใด ฉันรู้ว่าผลงานของเขานั้นยอดเยี่ยมมาก แต่ท้ายที่สุดแล้ว 'เวลล์เขาเป็นแค่ผู้ชายที่แต่งตัวประหลาดเท่านั้นรู้มั้ย?' คุณอาจต้องการอ่านโค้ดที่ Hadley เผยแพร่ที่ github github.com/hadley/roxygenและอาจส่งอีเมลถึงเขาและถามเขา ...
PaulHurleyuk

1
แน่นอน ฉันเคยเห็น Hadley ที่นี่ด้วยดังนั้นเขาอาจจะรู้ตัว ตอนแรกฉันคิดว่าจะพลาดอะไรบางอย่างในเอกสารเช่นคำสั่ง "@section Llamas" หรือคำสั่งที่คล้ายกัน
Spacedman

6
ฉันแน่ใจว่าชอบลามะ นั้นคือทั้งหมด.
JD Long

3
ดู@sectionแท็กใน roxygen2
hadley

คำตอบ:


23

เพิ่มการสนับสนุนนี้แล้ว (อย่างน้อยใน roxygen2) คุณเพียงแค่ต้องเพิ่ม@section Llamas:แล้วอะไรก็ได้หลังจากนั้นจนกว่าจะพบคำสั่งใหม่จะอยู่ในส่วน Llamas นี่คือตัวอย่าง

#' 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

\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.
}
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.