litr project

Создание litr

Примечание. Если вы хотите использовать пакет litr , посетите веб-сайт litr здесь, где вы сможете узнать о пакете. Если вас интересует, как производится litr , вы попали по адресу.

Фон

litr R позволяет писать пакеты R с использованием грамотного программирования. litr верят в грамотное программирование и поэтому, вполне естественно, хотят использовать грамотное программирование для litr . По очевидным причинам мы не могли использовать litr до его существования. Поэтому мы написали первоначальную жизнеспособную версию стандартным, неграмотным способом и выпустили ее как v0.0.1. Мы можем рассматривать это как «базовый случай». Это последняя версия, написанная традиционным способом. Каждая последующая версия litr будет генерироваться с использованием предыдущей версии litr . В частности, версия 0.0.2 пакета litr функционально эквивалентна версии 0.0.1, но пакет определяется в генерируемом файле .Rmd; вызов функции litr::render() версии 0.0.1 выводит пакет litr версии 0.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.