Dokumentieren einer Liste von Datenrahmen mit roxygen2

Question

Ich versuche, einige Daten zu dokumentieren, die ich in meinem Paket anfügen.

Ich habe eine Liste mit 3 Elementen (data.frames) und jeder dieser Datenrahmen hat einige Spalten. Ich frage mich, wie man diese hierarchische Struktur (list -> dat.frame -> column) innerhalb von roxygen2 dokumentiert. Die Beispiele zeigen immer nur eine Ebene, data.frame und dann Spaltennamen. Hier ist ein minimales Beispiel mit zwei Datenrahmen in einer Liste.

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

In meiner Liste, die alle drei data.frames sind mit einer id Säule verbunden, so dass sie Art verwendet, aber ich will sie nicht in einen Datenrahmen setzen, weil der Spar Speichers.

Alle Vorschläge sind willkommen.

EDIT

Ich versuchte Segmente meiner Dokumentation hinzufügen, aber dies scheint nicht

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

Die Ausgabe sieht aus wie es nur 1 @format Parameter verarbeiten kann zu arbeiten.

Irgendwelche anderen Vorschläge?

Answer 1

Eigentlich dachte ich nur eine Lösung aus, so lange niemand sonst einen besseren Vorschlag hat ...

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

Könnte auch mit

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

statt \enumerate Ich denke, gelöst werden. Aber diese Lösung funktioniert für jetzt.