litr project

litr erstellen

Hinweis: Wenn Sie das litr -Paket verwenden möchten, besuchen Sie bitte die litr -Website hier, wo Sie mehr über das Paket erfahren können. Wenn Sie sich dafür interessieren, wie litr hergestellt wird, sind Sie hier richtig.

Hintergrund

Das litr R-Paket ermöglicht das Schreiben von R-Paketen mithilfe kompetenter Programmierung. Die Entwickler von litr glauben an die Literate-Programmierung und möchten daher ganz natürlich Literate-Programmierung verwenden, um litr zu entwickeln. Aus offensichtlichen Gründen konnten wir litr nicht verwenden, bevor es existierte. Deshalb haben wir die erste brauchbare Version auf eine standardmäßige, nicht fachkundige Weise geschrieben und diese als v0.0.1 veröffentlicht. Wir können uns dies als den „Basisfall“ vorstellen. Dies ist die letzte Version, die auf traditionelle Weise geschrieben ist. Jede nachfolgende Version von litr wird mit der vorherigen Version von litr generiert. Insbesondere ist v0.0.2 von litr funktional äquivalent zu v0.0.1, aber das Paket ist in einer generierenden .Rmd-Datei definiert; Ein Aufruf von litr::render() von v0.0.1 gibt das litr Paket v0.0.2 aus. Das hört sich vielleicht alles kompliziert an, aber man kann sich das so vorstellen, als würden Entwickler eines Betriebssystems ihren Code wahrscheinlich auf einem Computer schreiben, auf dem die vorherige stabile Version des Betriebssystems läuft.

So generieren Sie eine neue Version von litr mit der vorherigen Version

Um eine neue Version von litr zu erstellen, installieren wir zunächst die neueste Version, nehmen dann alle gewünschten Änderungen an create-litr.Rmd vor und verwenden dann litr::render() der installierten Version, um die neue Version zu erstellen:

 remotes :: install_github( " jacobbien/litr-project@*release " , subdir = " litr " )
litr :: render( " create-litr/index.Rmd " )

Im obigen Code steht @*release für die neueste Version. Zum Zeitpunkt der Erstellung von Version 0.0.2 wäre dies beispielsweise v0.0.1 .

Dadurch wird zusammen mit diesem Bookdown die neue Version von litr generiert. Von dort aus können Sie wie jedes andere Paket erstellen/installieren. Verwenden Sie zum Überprüfen des Pakets

 devtools :: check( " litr " , document = FALSE )

Das document = FALSE verhindert, dass devtools seine Version von document() intern ausführt, wodurch die von litr::document() vorgenommenen Änderungen überschrieben würden.

Weitere Hinweise zum Mitwirken an litr finden Sie unter CONTRIBUTING.md.