2011-08-08 34 views
7

Roxygen đã làm cho công việc của tôi dễ dàng hơn rất nhiều và trong hầu hết các trường hợp là tốt đẹp và trực quan. Một điều mà tôi chưa bao giờ tìm ra dù là làm thế nào để giữ gìn thụt đầu dòng trong @examples phần để các kết quả của roxygenize("myPackage") chứaBảo tồn thụt đầu dòng trong các ví dụ phần

#' @examples 
#' sapply(1:10, function(i){ 
#'  x <- rbind(matrix(rnorm(20), 10, 2), 
#'    matrix(rnorm(20), 10, 2) + i) 
#'  myFunc(x) 
#' } 

sẽ

\examples{sapply(1:10, function(i){ 
    x <- rbind(matrix(rnorm(20), 10, 2), 
       matrix(rnorm(20), 10, 2) + i) 
    myFunc(x) 
}} 

thay vì

\examples{sapply(1:10, function(i){ 
x <- rbind(matrix(rnorm(20), 10, 2), 
matrix(rnorm(20), 10, 2) + i) 
myFunc(x) 
}} 

Đó là một chi tiết nhỏ nhưng nó làm cho tất cả, nhưng những ví dụ đơn giản nhất không cần thiết để đọc vì vậy tôi sẽ đánh giá cao nếu ai đó có thể giúp tôi.

Chỉnh sửa: Lỗi này đã được sửa trong các phiên bản sau của roxygen.

+0

Bạn đang sử dụng «roxygen' hoặc' roxygen2'? Tôi khá chắc chắn điều này không xảy ra trong roxygen2, và nếu nó là một lỗi, và cần được báo cáo. – hadley

+0

Tôi đã sử dụng đồng bằng cũ 'roxygen' nhưng vấn đề vẫn còn sau khi tôi cập nhật để' roxygen2'. gsk3 của giải pháp hoạt động cho cả hai mặc dù nhưng tôi đoán nó tốt hơn được báo cáo anyway. Làm thế nào để làm điều đó? – Backlin

+0

Vui lòng gửi báo cáo lỗi có thể tái sản xuất tại https://github.com/klutometis/roxygen/issues – hadley

Trả lời

4

Có thể là quá nhiều chi phí cho các ví dụ ngắn, nhưng đối với các ví dụ dài hơn, bạn có thể @example relative/path/to/example để kéo tệp, mà sẽ nhận được quyền thụt lề.

+0

Cảm ơn, nó hoạt động như một sự quyến rũ! Các chi phí không phải là xấu quá vì nó chỉ áp dụng cho một số ví dụ thường xuyên, đặc biệt là khi so sánh với gánh nặng nghiêm trọng của tự sửa chữa thụt đầu dòng. – Backlin

Các vấn đề liên quan