R/boilerplates.R

Defines functions boilerplate.git.ignore

Documented in boilerplate.git.ignore

#' boilerplate.git.ignore
#'
#' Just prints a boilerplate .gitignore. Will ignore a variety of files that I end up
#' saving with my R projects that shouldn't be sent to github, like pictures,
#' documents, .zips, slurm output, saved workspaces and R objects outside of data/,
#' shiny artifacts, etc.
#'
#' @export boilerplate.git.ignore
boilerplate.git.ignore <- function() {


  print(
'# slurm files
_rslurm*

# History files
.Rhistory
.Rapp.history

# Session Data files
.RData
*.RData

# and .rds (intermediate saves)
*.rds
*.RDS

# User-specific files
.Ruserdata

# Example code in package build process
*-Ex.R

# Output files from R CMD build
/*.tar.gz

# Output files from R CMD check
/*.Rcheck/

# RStudio files
.Rproj.user/

# produced vignettes
vignettes/*.html
vignettes/*.pdf

# other markdowns
*.html
*.pdf

# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth

# knitr and R markdown default cache directories
*_cache/
/cache/

# Temporary files created by R markdown
*.utf8.md
*.knit.md

# R Environment Variables
.Renviron
.Rproj.user

# ignore .csvs (but keep nhgis codebooks/documentation, which is .txt)
*.csv
*.csv.gz

# any R script prefixed with "." character
.*.R

# .scratch folders
.scratch
.older

# notes and other..
*.docx
*.tmp

#pictures
*.png
*.tiff

# zips
*.zip

# scratch scripts
.scratch.R

# files that may be created with shiny or RPubs
*.dcf
rsconnect/

'
)

}
kmcd39/taux documentation built on Jan. 29, 2024, 11:45 p.m.