procedure-to-create-package.R

In paezha/discrtr: A Companion Package for the Book "Discrete Choice Analysis with 'R'"

# Procedure to create a package from scratch

# Check this: https://lbusett.netlify.app/post/building-a-website-with-pkgdown-a-short-guide/

# PACKAGE CREATION
# Create package
usethis::create_package("C:/Antonio/packages/discrtr")


usethis::use_git()
usethis::use_git_ignore("procedure-to-create-package.R")
usethis::use_github()
usethis::use_build_ignore("procedure-to-create-package.R")

usethis::use_pkgdown()
pkgdown::build_site()

usethis::use_readme_rmd()
devtools::build_readme()

# Modify license
usethis::use_mit_license("Antonio Paez")
# Edit DESCRIPTION
devtools::document()


# As an alternative use_ccby_license()
#usethis::use_tidy_description()
# Use README.Rmd which is superior to README.md
usethis::use_readme_rmd()
# Add to the yaml header the following:
# ---
# output:
#  github_document:
#  pandoc_args: --webtex
#---
# Create script for documenting package and data
usethis::use_package_doc() # After this there is an R script in folder `R` with the name of the package

# ADD STUFF TO PACKAGE
# Add a folder to include raw data (which will not be included in the package)
usethis::use_data_raw()
# Create a notebook to process raw data: `process-energy-and-emissions.Rmd`
# Copy raw data files to folder data-raw
# Run/knit data processing notebook(s)
usethis::use_r(name = "multiplyr")
# Write function
#' Multiply two numbers
#'
#' @param a A number
#' @param b A number
#' @return The product of \code{a} and \code{b}
#' @export
#' @examples
#' multiplyr(2, 5)
#' multiplyr(4, 8)
#multiplyr <- function(a, b){
#  a * b
#}

# Create test
usethis::use_test(name = "multiplyr")
# Edit test file
# test_that("multiplyr-works", {
# expect_equal(multiplyr(3, 2), 6)
# })

# Documentation
# write documentation in file with package name and then run the following
devtools::document()
devtools::check()
devtools::build()
devtools::install()
# Edit README.Rmd and then render
devtools::build_readme()

# SAFETY: OPTIONAL!
usethis::use_git_ignore("data-raw")

# Set up git
usethis::use_git()
usethis::use_github()
usethis::use_github_action("pkgdown")
# Commit and push


#####################################