-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
89 lines (61 loc) · 3.68 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
---
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 <- "Title of your paper goes here"
```
# mininglucc
[](https://mybinder.org/v2/gh/fineprint-global/mininglucc/master?urlpath=rstudio) [](https://travis-ci.org/fineprint-global/mininglucc)
This repository contains the data and code for our paper:
> Authors, (YYYY). _`r Title`_. Name of journal/book <https://doi.org/xxx/xxx>
Our pre-print is online here:
> Authors, (YYYY). _`r Title`_. Name of journal/book, Accessed `r format(Sys.Date(), "%d %b %Y")`. Online at <https://doi.org/xxx/xxx>
### How to cite
Please cite this compendium as:
> Authors, (`r format(Sys.Date(), "%Y")`). _Compendium of R code and data for `r Title`_. Accessed `r format(Sys.Date(), "%d %b %Y")`. Online at <https://doi.org/xxx/xxx>
## Contents
The **analysis** directory contains:
- [:file\_folder: paper](/analysis/paper): R Markdown source document
for manuscript. Includes code to reproduce the figures and tables
generated by the analysis. It also has a rendered version,
`paper.docx`, suitable for reading (the code is replaced by figures
and tables in this file)
- [:file\_folder: data](/analysis/data): Data used in the analysis.
- [:file\_folder: figures](/analysis/figures): Plots and other
illustrations
- [:file\_folder:
supplementary-materials](/analysis/supplementary-materials):
Supplementary materials including notes and other documents
prepared and collected during the analysis.
## How to run in your broswer or download and run locally
This research compendium has been developed using the statistical programming
language R. To work with the compendium, you will need
installed on your computer the [R software](https://cloud.r-project.org/)
itself and optionally [RStudio Desktop](https://rstudio.com/products/rstudio/download/).
The simplest way to explore the text, code and data is to click on
[binder](https://mybinder.org/v2/gh///master?urlpath=rstudio)
to open an instance of RStudio in your browser, which will have the
compendium files ready to work with. Binder uses rocker-project.org
Docker images to ensure a consistent and reproducible computational
environment. These Docker images can also be used locally.
You can download the compendium as a zip from from this URL:
[master.zip](/archive/master.zip). After unzipping:
- open the `.Rproj` file in RStudio
- run `devtools::install()` to ensure you have the packages this analysis depends on (also listed in the
[DESCRIPTION](/DESCRIPTION) file).
- finally, open `analysis/paper/paper.Rmd` and knit to produce the `paper.docx`, or run `rmarkdown::render("analysis/paper/paper.Rmd")` in the R console
### Licenses
**Text and figures :** [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
**Code :** [GPL-3](http://www.gnu.org/licenses/gpl-3.0.html). See [LICENSE.md](LICENSE.md) and [DESCRIPTION](DESCRIPTION) files
**Data :**
- Mining polygons [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) attribution requested in reuse
- Mining commodities are simulated for reproducibility.
### Contributions
We welcome contributions from everyone. Before you get started, please see our [contributor guidelines](CONTRIBUTING.md). Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.