dev/devnotes.r

In donboyd5/geoWeight: Distribute Microdata Record Weights Across Different Geographies

# code folding ----
# alt-o, shift-alt-o
# alt-l, shift-alt-l
# alt-r

devtools::session_info()

# resources ----
# http://r-pkgs.had.co.nz/
# Developing packages: https://support.rstudio.com/hc/en-us/articles/200486488?version=1.3.1039&mode=desktop
# Build, test: https://support.rstudio.com/hc/en-us/articles/200486508-Building-Testing-and-Distributing-Packages
# Documenting: https://support.rstudio.com/hc/en-us/articles/200532317-Writing-Package-Documentation
# Documenting: https://cran.r-project.org/doc/manuals/R-exts.html#Writing-R-documentation-files

# Good intro: https://johnmuschelli.com/smi_2019/index.html
# Easier to use: https://github.com/muschellij2/smi_2019/blob/master/index.pdf

# https://cran.r-project.org/doc/contrib/Leisch-CreatingPackages.pdf
# http://portal.stats.ox.ac.uk/userdata/ruth/APTS2012/Rcourse10.pdf
# https://cran.r-project.org/doc/manuals/R-exts.html



# examples to learn from ----
# data package:  https://github.com/hadley/fueleconomy
# code package:  https://github.com/hadley/cubelyr


# general advice ----



# workflow ----
# Ctrl+Shift+D Update documentation
# Ctrl+Shift+B Build and reload

# package development tools ----
library(usethis)
library(devtools)
library(assertthat)

maxiter


# package setup ----
#.. create a  readme shell ----
usethis::use_readme_rmd()

# usethis::use_gpl3_license()
# usethis::use_gpl3_license(name = find_name())


#.. add packages etc. to DESCRIPTION ----
usethis::use_package("dplyr") # Defaults to imports
usethis::use_package("nleqslv") # Defaults to imports
usethis::use_package("minpack.lm") # Defaults to imports
usethis::use_package("purrr") # Defaults to imports
usethis::use_package("tidyr") # Defaults to imports

usethis::use_roxygen_md()
usethis::use_pipe(export = TRUE)

# usethis::use_package("tidyverse") # Defaults to imports ERROR

# examples of rbuildignore ----
use_build_ignore("./data/sourceData/", escape = TRUE, pkg = ".")
use_build_ignore("./R/DataConversionPrograms/", escape = TRUE, pkg = ".")


# package coding ----
#.. code formatting ----
# install.packages("formatR")
formatR::tidy_dir("R")

# install.packages("lintr")
lintr::lint_package()