litr project

litrの作成

注: litrパッケージの使用を検討している場合は、こちらのlitr Web サイトにアクセスしてください。そこでは、パッケージについて学ぶことができます。 litrがどのように作られるかに興味があるなら、ここは正しい場所です。

背景

litr R パッケージを使用すると、読み書き可能なプログラミングを使用して R パッケージを作成できます。 litrの開発者は読み書き可能なプログラミングの信奉者であるため、当然のことながら、読み書き可能なプログラミングを使用してlitr開発したいと考えています。明らかな理由により、 litr使用できませんでした。そこで、私たちは標準的な非リテラシー的な方法で最初の実行可能なバージョンを作成し、これを v0.0.1 としてリリースしました。これを「基本ケース」と考えることができます。これは、従来の方法で書かれた最後のバージョンです。後続のlitrバージョンは、以前のバージョンのlitrを使用して生成されます。特に、 litrの v0.0.2 は機能的に v0.0.1 と同等ですが、パッケージは生成される .Rmd ファイルで定義されます。 v0.0.1 のlitr::render()を呼び出すと、 litrパッケージ v0.0.2 が出力されます。これはすべて複雑に聞こえるかもしれませんが、これは、オペレーティング システムの開発者が、以前の安定したバージョンのオペレーティング システムを実行しているコンピュータ上でコードを記述する方法と考えることができます。

以前のリリースを使用して新しいバージョンのlitrを生成する方法

新しいバージョンのlitrを作成するには、まず最新リリースをインストールし、次にcreate-litr.Rmdに必要な変更を加えてから、インストールされたバージョンのlitr::render()を使用して新しいバージョンを作成します。

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

上記のコードでは、 @*release最新のリリースを表します。たとえば、バージョン0.0.2作成時には、これはv0.0.1になります。

これにより、このブックダウンとともに新しいバージョンのlitrが生成されます。そこから、他のパッケージの場合と同様にビルド/インストールできます。パッケージを確認するには、次を使用します。

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

document = FALSE devtoolsそのバージョンのdocument()を内部で実行することを防ぎます。これにより、 litr::document()が行った変更が上書きされます。

litrへの貢献に関する注意事項の詳細については、CONTRIBUTING.md を参照してください。