dpm.dash/README.Rmd at main · ONSBigData/dpm.dash · GitHub

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
---
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%"
)
```

# dpm_dash

## Overview

This interactive dashboard empowers you to explore and model your data using the dynamic population model (DPM).

## Contributor guidance

**In brief:**
All modifications to this package must be made through **Pull requests**, ideally linked to a specific GitHub **Issue**.

Pull requests should have a suitable pull request review form attached, with key notes/descriptions of changes made added by the requester and if applicable additional notes on particular areas to focus the review (syntax changes, key functional changes, documentational changes etc.)

## Getting started

### Installation
#### Install directly from GitHub

If you have linked your RStudio installation to GitHub you should be able to install the package directly from GitHub using the install_github method from the devtools package

``` {r installation_github, eval=FALSE}
# install.packages("devtools")
library(devtools)

devtools::install_github("ONSBigData/dpm_dash", build_vignettes = TRUE, INSTALL_opts = "--no-multiarch")
```

If you have not/are unable to link your RStudio installation to GitHub (you may encounter a 404 error when attempting the previous approach) you can also install the package in two alternative ways

#### Install locally from .zip

Download a copy of the package repository as a .zip file (option in 'Code', below Open with GitHub Desktop) and install using the install_local method from the devtools package (replace the path with the path to the .zip file download location)

``` {r installation_zip, eval=FALSE}
# install.packages("devtools")
library(devtools)

devtools::install_local("C:/.../Downloads/dpm_dash-main.zip", build_vignettes = TRUE, INSTALL_opts = "--no-multiarch")
```

#### Install locally from cloned repository

Clone the repository (options in 'Code' to HTTPS/SSH paths) and build the package using the build() method from the devtools package

``` {r installation_clone, eval=FALSE}
# install.packages("devtools")
library(devtools)

dpm_dash_build <- devtools::build("~/put/the/package/path/here")

devtools::install_local(dpm_dash_build, build_vignettes = TRUE, INSTALL_opts = "--no-multiarch")
```

### Usage (example)

Once you have installed the dpm.dashboard package all you need to do to run the dashboard
is using the run_dpm_dashboard() function

```{r dpm_dashboard, eval=FALSE}
dpm_dash::run_dev_dash()

or

library(dpm_dash)
run_dev_dash()
```

This will launch the dashboard, allowing us to get started with using the DPM.

## FAQs/Help


## License
By contributing, you agree that your contributions will be licensed under its [MIT License](http://choosealicense.com/licenses/mit/). For additional information regarding the licensing, and related copyright, of this code please refer to the [LICENSE](https://github.com/ONSdigital/accountTMB/blob/main/LICENSE.md)