-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathREADME.Rmd
115 lines (86 loc) · 3.51 KB
/
README.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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# monash
<!-- badges: start -->
<!-- badges: end -->
The `monash` R-package is a utility package with consolidated tools and templates for staffs at Monash University. The package contains three primary themes:
* **workflow**: automating repetitive tasks, particularly teaching related activities;
* **template**: Monash branded R Markdown templates for teaching, presentation, etc; and
* **data**: easy access to relevant information (may require access privileges).
## Installation
You can install `monash` R-package as below:
``` r
# install.packages("remotes")
remotes::install_github("numbats/monash")
```
## Get Monash logo
You can get a copy of the logo into the directory you wish with below.
```{r logo}
# default logo
monash::logo_get(path = "man/figures")
# black and white & one-line version of the logo
monash::logo_get(path = "man/figures", color = "black", stack = FALSE, filename = "monash-logo-black.png")
```
And then you can reference the logo file that you copied.
## Get Monash brand colors
These are handy commands to quickly see Monash brand colors and be able to copy-and-paste the hex color codes.
```{r}
monash::color_show()
```
## Settings
(WIP) The monash package makes use of some values, listed below, from your R profile.
You can modify this by using `usethis::edit_r_profile()` and adding below with
values modified to your own values.
```
options(monash.full_name = "Emi Tanaka",
monash.email = "[email protected]",
monash.orgunit = "Department of Econometrics and Business Statistics",
monash.teaching_dir = "~/teaching/monash/",
monash.workshop_dir = "~/workshop/")
```
## Teaching
(WIP) `create_teaching_directory("ETCXXXX")` would create a skeleton directory with folder and file structure below for development of teaching material. What is the advantage of this structure? It's designed to be synced with a private github repository and the materials in the `release` folder are *automatically* pushed using Github Repository to the public github repository for public release. The website associated with it will be also be built automatically as well. The website format will closely resemble [ETC5512: Wild-Caught Data](https://wcd.numbat.space/).
(WIP) `release_tutorial(1)` moves `tutorial-01.html` (and .Rmd) to the appropriate place in the `release` folder.
(WIP) Tutorial, slides and other templates for teaching.
```
├── ETCXXXX.Rproj
├── .git
├── data
│ └── data01.csv
├── lectures
│ ├── assets
│ │ ├── monash-brand.css
│ │ └── monash-font.css
│ ├── images
│ │ ├── lecture-01-image01.png
│ │ └── lecture-02-image01.png
│ ├── lecture-01.Rmd
│ ├── lecture-02.Rmd
│ └── lecture-03.Rmd
├── tutorials
│ ├── images
│ │ ├── tutorial-01-image01.png
│ │ └── tutorial-02-image01.png
│ ├── tutorial-01.Rmd
├── assessments
│ ├── assignment-01.Rmd
│ └── quiz-01.Rmd
├── release # for public release
│ ├── site
│ │ └── _site.yml
│ ├── data
│ ├── lectures
│ ├── tutorials
```