forked from ideas-lab-nus/eplusr-paper
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
75 lines (49 loc) · 2.14 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
# Please put your title here to include it in the file below.
Title <- "A framework for integrating building energy simulation and data-driven analytics"
Author <- "Hongyuan Jia and Adrian Chong"
Journal <- "Energy and Buildings"
```
# eplusr framework
<!-- badges: start -->
[](https://github.com/ideas-lab-nus/eplusr-paper/actions)
<!-- badges: end -->
This repository contains the data and code for paper:
> `r Author`, (2020). _`r Title`_. (In review)
### How to cite
Please cite this compendium as:
> `r Author`, (`r format(Sys.Date(), "%Y")`). _Compendium of R code and data for `r Title`_. Accessed `r format(Sys.Date(), "%d %b %Y")`.
### How to download or install
**(a) Option 1: Download the compiled draft PDF**
The latest compiled draft PDF can be downloaded from the `Actions` → `Artifacts`.
**(b) Option 2: Download the compendium and compile the PDF**
You can download the compendium as a zip from from this URL:
<https://github.com/ideas-lab-nus/eplusr-paper/archive/master.zip>
Or you can install this compendium as an R package, eplusr-paper, from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("ideas-lab-nus/eplusr-paper")
```
The PDF can be compiled via:
```{r, eval = FALSE}
rmarkdown::render('vignettes/paper.Rmd')
```
### Licenses
**Text and figures :** [CC-BY-4.0](http://creativecommons.org/licenses/by/4.0/)
**Code :** See the [DESCRIPTION](DESCRIPTION) file
**Data :** [CC-0](http://creativecommons.org/publicdomain/zero/1.0/) attribution
requested in reuse
### Contributions
We welcome contributions from everyone. Before you get started, please see our
[contributor guidelines](.github/CONTRIBUTING.md). Please note that this project
is released with a [Contributor Code of Conduct](.github/CONDUCT.md). By participating
in this project you agree to abide by its terms.