In davidmeza1/MezaEdD:

Motivation

As I pursue my doctorate I have to think about how I will produce and organize my thoughts, papers, assignments, and anything else to do with the program. I have decided to create an R package project. Why? I am not sure yet, however my gut is telling me to go this way. Probably for reproducibility and portability of my work. I also want to see if it is a useful model for producing and capturing work product.

I will do all my work in R and RStudio to see if it is an acceptable and useful method for collecting and organizing all my thoughts and work. The package will contain all data sets and code I will use in my research, any papers or presentations and of course, my ramblings. I am doing this primarily for myself, however I may release this later, to see if it may be useful to others.

I will use the package bookdown to organize all my work. This package focuses on the features to writing books, long-form article, or reports, such as

• How to typeset figures and tables, and cross-reference them;
• How to generate multiple output formats such as HTML, PDF, and e-books for a single book;
• How to customize the book templates and style different elements in a book;
• The editor support (in particular, the RStudio IDE);
• How to publish a book [@xie2016]

You can use anything that Pandoc's Markdown supports, e.g.,a math equation $a^2 + b^2 = c^2$.

I will detail how I set this package up and the structure of the book in later chapters. For now, if you want to compile the book, you have to install the development versions of bookdown from Github, at the time of this writing:

devtools::install_github("rstudio/bookdown")

You should also review the book Bookdown: Authoring Bools with R Markdown to understand how to create your own publication.

Conventions

In this book I will use various block types to call out information I may want to remember.

```{block, type='rmdnote'} This is a Note. Here I will try to point out information that I have found to be useful in my everyday analysis.

```{block, type='rmdcaution'}
This is a **Caution**. I will try to point out areas where you should tread lightly or where it is easy to make 
mistakes.

```{block, type='rmdimportant'} This is Important. I will try to point out areas that have made my data science life miserable, we are talking bang-your-head, pull-out-your-hair and scream mistakes as well as those things that can save you time and make you look important.

```{block, type='rmdtip'}
This is a **Tip**. Here I will try to highlight bits of information that I have found useful and have made
it easier for me to do analysis.

```{block, type='rmdwarning'} This is a Warning, Will Robinson. Similar to Caution, however you should avoid them if at all possible.

```r
# automatically create a bib database for R packages
knitr::write_bib(c(
  .packages(), 'bookdown', 'knitr', 'rmarkdown'
), 'packages.bib')

davidmeza1/MezaEdD documentation built on May 15, 2019, 1:15 a.m.