pdata/BuildingTheLibrary.Rmd at master · garyfeng/pdata · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
---
title: "How To Build This Package"
author: "Gary Feng"
date: "September 19, 2015"
output: html_document
---

```{r}
require(devtools)
#   http://r-pkgs.had.co.nz/
#
# Some useful keyboard shortcuts for package authoring:
#
#   Build and Reload Package:  'Cmd + Shift + B'
#   Check Package:             'Cmd + Shift + E'
#   Test Package:              'Cmd + Shift + T'

```


## Creating vignettes

Vignettes are tutorials on to use the library to perform real tasks. The following vignettes help users with a sense of the workflow and with completing individual tasks.

**Warning: running the following code will overwrite any existing vignettes you have already created.**

```{r eval=FALSE}
# data import from XML and other sources
devtools::use_vignette("ReadData")
# the data structure and how to transform the data for analysis
devtools::use_vignette("ManipulateData")
# visualization
devtools::use_vignette("VisualizeData")
# examples of how to do analysis and modeling of specific data types
devtools::use_vignette("AnalyzeData")
devtools::use_vignette("AnalyzeData_keystrokes")
# validation using
devtools::use_vignette("ValidateData")
# reporting
devtools::use_vignette("ReportData")

```