-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
113 lines (85 loc) · 2.9 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
---
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%"
)
```
# healthgpsrvis
<!-- badges: start -->
[![R-CMD-check](https://github.com/imperialCHEPI/healthgpsrvis/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/imperialCHEPI/healthgpsrvis/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of `healthgpsrvis` is to plot and visualise data related to Health-GPS.
## Getting Started
### Prerequisites
- [RStudio](https://posit.co/download/rstudio-desktop/) installed
<!-- - [renv](https://rstudio.github.io/renv/) installed -->
### Installation
You can install the development version of `healthgpsrvis` from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("imperialCHEPI/healthgpsrvis")
```
## Example
This is a basic example which shows you how to solve a common problem:
```{r example}
library(healthgpsrvis)
data_mean_weighted <- data.frame(
time = rep(seq(2020, 2055, by = 5), 3),
weighted_bmi = runif(24, 25, 38),
weighted_energyintake = runif(24, 1700, 2750),
weighted_fat = runif(24, 38, 120),
weighted_obesity = runif(24, 0.1, 0.7),
weighted_protein = runif(24, 46, 210),
weighted_sodium = runif(24, 874, 2768),
source = rep(c("Source_1", "Source_2", "Source_3"), each = 8)
)
plot_bmi <- riskfactors("bmi", data_mean_weighted)
plot_bmi
```
What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
```{r cars}
# summary(cars)
```
You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
You can also embed plots, for example:
```{r pressure, echo = FALSE}
# plot(pressure)
```
In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
<!--
### Cloning the Repository
```bash
git clone https://github.com/imperialCHEPI/healthgps-plots.git
cd healthgps-plots
```
### Setting Up the Project Environment with renv
1. Activate the renv environment:
```bash
Rscript -e 'renv::activate()'
```
2. Install project dependencies:
```bash
Rscript -e 'renv::restore()'
```
### Running the Script
You can now run the visualisation script using:
```bash
Rscript Visualisation.R path/to/HealthGPS_Result_S1.csv path/to/HealthGPS_Result_S2.csv path/to/HealthGPS_Result_S4.csv path/to/HealthGPS_Result_S5.csv
```
### Updating Dependencies
If you make changes to the project dependencies or want to ensure you have the latest versions, you can update the renv.lock file:
```bash
Rscript -e 'renv::snapshot()'
```
### Deactivating the renv Environment
After you are done using the project, you can deactivate the renv environment:
```bash
Rscript -e 'renv::deactivate()'
```
-->