8 Conclusion

8.1 Write internal data to package

## defined in 02_basics.Rmd
usethis::use_data(equal_pm, internal = TRUE, overwrite = TRUE)

## ✔ Adding 'R' to Depends field in DESCRIPTION
## ✔ Saving 'equal_pm' to 'R/sysdata.rda'

8.2 Document the package

When you are done defining the package, it remains to convert the Roxygen to documentation.

rm(list = ls())
litr::document() # <-- use instead of devtools::document()

## ℹ Updating conformr documentation
## ℹ Loading conformr

## Warning: []8;line = 12:col = 1;file:///Users/cynthiahqy/Dropbox/WORK/RA_2022/
## conformr-project/conformr/R/check_weights.Rcheck_weights.R:12]8;;] @exports is
## not a known tag

## Warning: []8;line = 16:col = 1;file:///Users/cynthiahqy/Dropbox/WORK/RA_2022/
## conformr-project/conformr/R/concord.Rconcord.R:16]8;;] @return requires a value

## Warning: []8;line = 15:col = 1;file:///Users/cynthiahqy/Dropbox/WORK/RA_2022/
## conformr-project/conformr/R/make_pm_equal.Rmake_pm_equal.R:15]8;;] @examples
## requires a value

## Writing ']8;;file:///Users/cynthiahqy/Dropbox/WORK/RA_2022/conformr-project/conformr/NAMESPACENAMESPACE]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('check_coverage')check_coverage.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('check_missing')check_missing.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('check_weights')check_weights.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('concord')concord.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('conformr-package')conformr-package.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('has_bad_weights')has_bad_weights.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('has_coverage')has_coverage.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('has_missing')has_missing.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('make_pm_equal')make_pm_equal.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('use_panel_map')use_panel_map.Rd]8;;'
## Writing ']8;;ide:run:pkgload::dev_help('%||%')grapes-or-or-grapes.Rd]8;;'

You can also add some extra things to your package here if you like, such as a README, some vignettes, a pkgdown site, etc. See here for an example of how to do this with litr.

8.3 Include pacakge README.md

litr::add_readme(file.path("..", "source-files", "README.Rmd"))

## ✔ Writing 'README.Rmd'
## ✔ Adding '^README\\.Rmd$' to '.Rbuildignore'
## ✔ Creating '.git/hooks/'
## ✔ Writing '.git/hooks/pre-commit'