In thmshrt/writethat: Provides CRAN Valid Documentation Templates

---

title: "Rapid Development with writethat" author: "Thomas Hart" site: bookdown::bookdown_site output: bookdown::gitbook bibliography: [references.bib]

---

knitr::opts_chunk$set(
  echo = TRUE,
  warning = FALSE,
  message = FALSE
  )

About {-}

Motivation {-}

Package development in R can be tricky. For new developers, it is not obvious where to place the title of your documentation, the description of your documentation, or @import for that matter. This can produce warnings and notes while checking a package before submitting it to CRAN that are time consuming to fix. In addition the format of documentation is not always conducive to developing. For instance @examples must be placed before a function, whereas the natural call order for R is top to bottom of a file. writethat looks to address these issues. See [Roadmap] for status of features.

Installation {-}

writethat will be available in CRAN as soon as it is approved

install.packages('writethat')

For now writethat can be installed from github using

library(devtools)
devtools::install_github('thmshrt/writethat')

thmshrt/writethat documentation built on Dec. 31, 2020, 8:37 a.m.