R/README.md

In lwjohnst86/seminar2016: Slides and Data Analysis for PhD Seminar Fall 2016

Description of R/ files

This folder contains custom functions used for this project's analyses. It's recommended that if a piece of code is used more than once in your analysis files, make it into a function and put it here so that you "Don't Repeat Yourself" (DRY principle). Or even if the piece of code is complicated, put it into a function to then document what it does.

Use RStudio's R script 'Insert Section' (Ctrl-Shift-R) to split up your functions by utility or purpose. You can see the contents of this file easily using the 'Document Outline' (Ctrl-Shift-O), which shows the sections and functions. Use 'Insert Roxygen Skeleton' (Ctrl-Alt-Shift-R) to document individual functions.

Best practice is to split the functions up into individual files based on what the functions do. For example, have one file for plotting functions (plots.R), another for data wrangling functions (wrangle.R), and so on. These functions can then be referenced either by running devtools::load_all() (Ctrl-Shift-L) for interactive use or for Rmd files to knit to another document format (e.g. Word), building first (devtools::build(); Ctrl-Shift-B) and adding library(projectname) to the Rmd code (or just devtools::load_all()).

lwjohnst86/seminar2016 documentation built on May 21, 2019, 9:15 a.m.