roxygen2를 사용하여 데이터 프레임 목록을 문서화합니다.

Question

패키지에 추가 할 데이터를 문서화하려고합니다.

나는 3 개의 요소 (data.frames)가있는 목록을 가지고 있으며이 데이터 프레임 각각에는 몇 개의 열이 있습니다. roxygen2 내에서이 계층 구조 (list -> data.frame -> column)를 문서화하는 방법에 대해 궁금합니다. 예제에서는 항상 하나의 레이어, data.frame 및 열 이름 만 표시합니다. 다음은 목록에 두 개의 데이터 프레임이있는 최소 예제입니다. 내 목록에서

list(
    names=data.frame(id=1:10, a=letters[1:10]), 
    values=data.frame(id=rep(1:10, each=10), values=runif(100)) 
) 

, 세 data.frames는 id 열이 연결되어, 그래서 그들은 가지 관련이 있습니다,하지만 난 때문에 저장 메모리, 하나 개의 데이터 프레임에 넣어 싶지 않아요.

모든 의견을 환영합니다.

편집

는 내 문서에 세그먼트를 추가하려고하지만 그것은 단지 1 개 @format 매개 변수를 처리 할 수있는 것처럼 출력이 보이는

#' List with group information for the test data set 
#' 
#' This dataset is a list with 2 data.tables (proteins, timepoint). 
#' It has a common id column in all data.tables. 
#' 
#' \strong{proteins} 
#' @format A data frame with 5458 rows and 3 columns 
#' \describe{ 
#' \item{id}{unique group id} 
#' \item{names}{individual names} 
#' \item{other names}{other names} 
#' } 
#' 
#' \strong{timepoint} 
#' @format A data frame with 80248 rows and 5 columns 
#' \describe{ 
#' \item{id}{unique group id} 
#' \item{timepoint}{individual timepoint} 
#' \item{imputed_mean}{mean value including imputed values} 
#' \item{measured_mean}{mean value without imputing (contains NAs)} 
#' \item{value_count}{number of measured values within the replicates} 
#' } 
'pg_test' 

작동하지 않습니다.

다른 제안 사항이 있습니까?

Answer 1

사실, 난 그냥 ... 한 아무도 다른 더 나은 제안이없는, 해결책을 알아 냈

#' List with group information for the test data set 
#' 
#' This dataset is a list with 2 data.tables (proteins, timepoint). 
#' It has a common id column in all data.tables. 
#' 
#' @format 
#' \enumerate{ 
#' \item \strong{proteins} A data frame with 5458 rows and 3 columns 
#' \describe{ 
#' \item{id}{unique group id} 
#' \item{names}{individual names} 
#' \item{other names}{other names} 
#' } 
#' 
#' \item \strong{timepoint} A data frame with 80248 rows and 5 columns 
#' \describe{ 
#' \item{id}{unique group id} 
#' \item{timepoint}{individual timepoint} 
#' \item{imputed_mean}{mean value including imputed values} 
#' \item{measured_mean}{mean value without imputing (contains NAs)} 
#' \item{value_count}{number of measured values within the replicates} 
#' } 
#' } 
'pg_test' 

는 대신 같아요 \enumerate의

#' \describe{ 
#' \item{One}{First item} 
.... 

해결 될 수 없습니다. 그러나이 솔루션은 현재 작동합니다.