Wann sollten Daten in / Daten gehen und wann sollte es in / inst / extdata gehen?

8

Die Schreiben von R-Erweiterungen manual states:

  

Das Unterverzeichnis data dient für Datendateien, die entweder über Lazy-Loading oder zum Laden mit Daten zur Verfügung gestellt werden (). (Die Auswahl erfolgt über das Feld 'LazyData' in der Datei 'DESCRIPTION'; der Standardwert ist dies nicht.) Es sollte nicht für andere Datendateien verwendet werden, die von dem Paket benötigt werden, und die Konvention ist für die Verwendung des Verzeichnisses inst / extdata für solche Dateien.)

Aber es ist noch nicht klar, welche Daten von einem Paket "benötigt" werden. Ich möchte Daten für die folgenden (nicht immer sich gegenseitig ausschließenden) Gründe verwenden:

  • Dokumentation
    • Funktionsbeispiele
    • Funktionstests
    • Vignetten
  • um den Zugriff auf einen Originaldatensatz zu ermöglichen
  • um Daten für Funktionen innerhalb des Pakets verfügbar zu machen (z. B. eine Nachschlagetabelle / ein Verzeichnis)

Es ist jedoch nicht klar, welche davon in den Ordner data und welche in inst/extdata gehen soll. Und gibt es irgendwelche Bedingungen, unter denen "Daten" woanders hingehen sollten?

Verwandte Fragen: Vorherige Fragen (zB inst und extdata-Ordner in R Packaging und Verwenden von inst / extdata mit Vignette während der Paketprüfung R 2.14.0 ) geben Sie einige Anweisungen zur Verwendung, aber sagen Sie mir nicht, wie ich entscheiden soll, welches Verzeichnis verwendet werden soll. Eine andere Frage, R - wo sollte ich RDA platzieren file - / R, / data, / inst / extdata? , kommt am nächsten, scheint sich aber speziell auf RDA- und RData-Dateien zu konzentrieren.

    
David LeBauer 10.12.2012, 21:24
quelle

1 Antwort

10

Das Verzeichnis data stellt Daten für die Funktion data() bereit und soll bestimmten Gewohnheiten in Bezug auf Dateiformate und Erweiterungen folgen.

Das inst/extdata -Verzeichnis wird zu extdata/ , wenn es installiert wird, und ist mehr ein Wilder Westen und Sie können tun, was Sie wollen und es wird erwartet, dass Sie Ihre eigenen Accessoren schreiben.

Es kann nützlich sein, sich empirisch zu betrachten. Auf meiner Maschine, unter etwa 240 - einige installierte Pakete, haben volle 77 (oder nicht ganz ein Drittel) data/ , aber nur 4 (einschließlich einer von mir) haben extdata. .

    
Dirk Eddelbuettel 10.12.2012 21:40
quelle

Tags und Links