Các phần tùy ý trong tài liệu roxygen

Cách Roxygen hoạt động dường như là dòng đầu tiên là dòng \title, mọi thứ khác nằm trong \detailsvà sau đó bất kỳ lệnh nào @fooxử lý những thứ đó. Nhưng tài liệu R phong phú hơn thế. Tôi có thể có "\section{Llamas}{Are they ungulates?}"trong tệp .Rd.

Nhưng tôi không thể yêu cầu Roxygen làm bất cứ điều gì khác ngoài việc gói gọn tất cả trong \ chi tiết. Tui bỏ lỡ điều gì vậy?

Tôi có một giải pháp hacky, đó là dán một thứ chưa từng có }trước của tôi \section. Điều này sau đó kết thúc \detailsphần. Sau đó, tôi không phải đặt một kết thúc }vào, bởi vì roxygen dính vào suy nghĩ của nó đóng \details. Eeeeeurrrrrrrrgh.

r roxygen

— Spacedman
nguồn

Câu hỏi hay. Tôi nghi ngờ bạn là chính xác rằng điều này không thể được thực hiện vào lúc này. Nhưng Hadley Wickham gần đây đã đề cập rằng anh ấy nắm giữ chìa khóa cho sự phát triển trong tương lai của roxygen, vì vậy tôi hy vọng rằng một điều gì đó tuyệt vời sẽ xuất hiện trong tương lai gần.

— Andrie

Tùy thuộc vào mức độ chuyên sâu bạn muốn tìm hiểu, bạn có thể đề nghị giúp Hadley về những gì anh ấy đang làm. Tôi biết công việc của anh ấy thật tuyệt vời, nhưng sau tất cả, 'Vell, anh ấy chỉ là một chàng trai zis, bạn biết không?'. Bạn có thể muốn kiểm tra nội dung mã Hadley đã được xuất bản tại github github.com/hadley/roxygen và có thể gửi cho anh ta một email và yêu cầu anh ta ...

— PaulHurleyuk

Chắc chắn rồi. Tôi cũng đã thấy Hadley ở đây, nên anh ấy có thể biết. Lúc đầu, tôi nghĩ rằng tôi đã bỏ lỡ điều gì đó trong tài liệu, chẳng hạn như chỉ thị "@section Llamas" hoặc tương tự.

— Spacedman

Tôi chắc chắn thích lạc đà không bướu. Đó là tất cả.

— JD Dài

Xem các @sectionthẻ trong roxygen2

— hadley

Hỗ trợ này đã được thêm vào (ít nhất là trong roxygen2). Bạn chỉ cần thêm @section Llamas:và sau đó bất cứ thứ gì sau đó cho đến khi một chỉ thị mới được đáp ứng sẽ nằm trong phần Llamas. Đây là một ví dụ

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

cung cấp thông tin sau cho tệp .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
nguồn