litr project

Création litr

Remarque : Si vous souhaitez utiliser le package litr , veuillez visiter le site Web litr ici, où vous pourrez en savoir plus sur le package. Si vous êtes intéressé par la façon dont litr sont fabriqués, vous êtes au bon endroit.

Arrière-plan

Le package litr R permet d'écrire des packages R en utilisant une programmation compétente. Les développeurs de litr croient en la programmation littéraire et souhaitent donc, tout naturellement, utiliser la programmation littéraire pour développer litr . Pour des raisons évidentes, nous ne pouvions pas utiliser litr avant qu'il n'existe. Nous avons donc écrit la version viable initiale d'une manière standard et non alphabétisée et l'avons publiée sous le nom de v0.0.1. Nous pouvons considérer cela comme le « cas de base ». Il s’agit de la dernière version écrite de manière traditionnelle. Chaque version ultérieure de litr sera générée en utilisant la version précédente de litr . En particulier, la v0.0.2 de litr est fonctionnellement équivalente à la v0.0.1, mais le package est défini dans un fichier générateur .Rmd ; un appel au litr::render() de la v0.0.1 génère le package litr v0.0.2. Tout cela peut sembler compliqué, mais on peut considérer cela comme la façon dont les développeurs d'un système d'exploitation écrivent probablement leur code sur un ordinateur qui exécute la version stable précédente du système d'exploitation.

Comment générer une nouvelle version de litr en utilisant la version précédente

Pour créer une nouvelle version de litr , nous installons d'abord la dernière version, puis apportons les modifications souhaitées à create-litr.Rmd , puis utilisons litr::render() de la version installée pour créer la nouvelle version :

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

Dans le code ci-dessus, @*release représente la dernière version. Par exemple, au moment de la création de la version 0.0.2 , ce serait v0.0.1 .

Cela générera la nouvelle version de litr avec ce bookdown. À partir de là, vous pouvez créer/installer comme vous le feriez pour n’importe quel autre package. Pour vérifier le colis, utilisez

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

Le document = FALSE empêche devtools d'exécuter leur version de document() en interne, ce qui écraserait les modifications apportées par litr::document() .

Pour plus de notes sur la contribution à litr , veuillez consulter CONTRIBUTING.md.