forked from TWUOnline/bookdown-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path07-getting-started.Rmd
116 lines (78 loc) · 6.26 KB
/
07-getting-started.Rmd
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# Getting Started
## Creating your Bookdown course {-}
Go to: https://github.com/rstudio/bookdown-demo
You will need the following:
- [R](https://cran.r-project.org/bin/windows/base/) installed
- [Rstudio](https://www.rstudio.com/products/rstudio/download/) installed
- [GitHub account & GitHub Desktop](https://github.com/)
- Optional: [Atom](https://atom.io/) or [VSCode](https://code.visualstudio.com/) installed
See below for explanations and instructions.
### R & RStudio {-}
RStudio is an integrated development environment for R, a programming language for statistical computing and graphics. It is available in two formats: RStudio Desktop is a regular desktop application while RStudio Server runs on a remote server and allows accessing RStudio using a web browser. [Wikipedia](https://en.wikipedia.org/wiki/RStudio)
```{block, type='reflect'}
1. Install R from [https://cran.r-project.org/bin/windows/base/](https://cran.r-project.org/bin/windows/base/) (Download R 4.1.1 for Windows or Mac, as appropriate)
1. Download R studio (free) [https://www.rstudio.com/products/rstudio/download/](https://www.rstudio.com/products/rstudio/download/)
1. You may need to install packages. You can do this by adding the commands to the console, or go to Tools > Install Packages
- `install.packages('rmarkdown')`
- `install.packages('rlang')`
- `install.packages('bookdown')`
8. If install doesn't work, go to source of package. e.g. [https://cloud.r-project.org/web/packages/bookdown/index.html](https://cloud.r-project.org/web/packages/bookdown/index.html)
```
### Git, GitHub, GitHub Desktop {-}
GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
```{block, type='reflect'}
1. Create a [GitHub account](https://github.com/)
1. See the [GitHub tutorial](https://docs.github.com/en/get-started/quickstart/hello-world)
```
### Atom {-}
Atom is a free and open-source text and source code editor for macOS, Linux, and Microsoft Windows with support for plug-ins written in JavaScript, and embedded Git Control. Developed by GitHub, Atom is a desktop application built using web technologies. Most of the extending packages have free software licenses and are community-built and maintained. ([Wikipedia](https://en.wikipedia.org/wiki/Atom_(text_editor)).
This is optional, but is definitely handy in creating with Bookdown.
```{block, type='reflect'}
1. Install [Atom](https://atom.io/)
1. Alternatively, install [VSCode](https://code.visualstudio.com/)
```
---
## Creating Your Book from a GitHub Repository {-}
If you see a Book you'd like to copy/modify, then go to the repository in GitHub and fork it.
See the following directions from [GitHub Docs](https://docs.github.com/en/get-started/quickstart/hello-world)
```{block, type='reflect'}
### Creating a repository
A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets -- anything your project needs. Often, repositories include a README file, a file with information about your project. README files are written in the plain text Markdown language. You can use this [cheat sheet](https://www.markdownguide.org/cheat-sheet/) to get started with Markdown syntax. GitHub lets you add a README file at the same time you create your new repository. GitHub also offers other common options such as a license file, but you do not have to select any of them now.
Your hello-world repository can be a place where you store ideas, resources, or even share and discuss things with others.
1. In the upper-right corner of any page, use the drop-down menu, and select New repository.
1. In the Repository name box, enter hello-world.
1. In the Description box, write a short description.
1. Select Add a README file.
1. Select whether your repository will be Public or Private.
1. Click Create repository.
```
## Creating a Book in RStudio {-}
Here are the instructions from https://bookdown.org/home/about/.
```{block, type='reflect'}
Below are a few simple steps for you to get started with writing a book using bookdown. For the comprehensive documentation of bookdown, please see https://bookdown.org/yihui/bookdown.
### 1. Install
a. First install the bookdown R package as follows:
- you can either use the CRAN version
install.packages('bookdown')
- or the development version on Github
remotes::install_github('rstudio/bookdown')
The [RStudio IDE](https://www.rstudio.com/products/rstudio/download/preview/) is recommended but not strictly required (we will show it in the next steps).
### 2. Edit
One way to get started is to fork or clone the repository https://github.com/rstudio/bookdown-demo (if you are not familiar with Git and GitHub, you can alternatively download it as a zip file and unzip it). Alternatively, if you are using a recent version of the RStudio IDE, you can directly create a book project in the IDE.
Open the demo book project within RStudio, open the index.Rmd file, and click the Knit button:
Now you should see the index page of this book demo in the preview window
The Knit button renders just the chapter you are currently editing (e.g. index.Rmd, 01-intro.Rmd, etc.) using the default output format for the book. To build all chapters and all formats of the book you can use the Build Book button within the RStudio Build pane:
By default the HTML, PDF, and ePub formats of the book will be compiled into the book sub-directory of the project (you can also build a single format at a time using the Build Book menu).
Note that if you want to generate PDF, you’d need a LaTeX distribution.
### 3. Publish
To publish your books to bookdown.org, you need to first create an account by signing in with your Google account, and then call the function publish_book() in R:
bookdown::publish_book(render = 'local')
If it is the first time you have tried to publish the book, you will be asked to authorize bookdown to publish to your bookdown.org account.
```
---
## Making Edits to Book {-}
1. In GitHub desktop, clone the repository to your computer. (e.g. [https://github.com/ma-lead](https://github.com/ma-lead))
2. In Atom: Edit content
3. In RStudio: Build book, see preview
4. In GitHub Desktop: Commit to main and Push origin
