|
|
# Contributing Guidelines
|
|
|
|
|
|
Thank you for contributing to this project! Please follow the guidelines below to maintain consistency in the project, especially for visualizations.
|
|
|
|
|
|
## General Guidelines
|
|
|
|
|
|
1. **Use Markdown**: All documentation should be written using Markdown to ensure readability and consistency across the project.
|
|
|
|
|
|
2. **File and Folder Structure**: Make sure your code is saved in the `rcode` folder, and images are placed in the `images` folder.
|
|
|
|
|
|
3. **Commit Messages**: Use clear and concise commit messages that describe the changes you’ve made.
|
|
|
|
|
|
## Visualization Guidelines
|
|
|
|
|
|
To ensure uniformity, all visualizations should use the following font and color scheme:
|
|
|
|
|
|
### Font
|
|
|
- **Sans-serif**: Use a generic sans-serif font, which is the default in most systems, such as Segoe UI on Windows or San Francisco on macOS.
|
|
|
|
|
|
### Color Palette
|
|
|
- **Green**: `#608C32`
|
|
|
- **Blue**: `#0063A7`
|
|
|
- **Black**: `black`
|
|
|
- **Grey**: `grey50`
|
|
|
|
|
|
### Applying the Theme
|
|
|
|
|
|
Here is the R code snippet to use for ensuring that your visualizations follow the correct color palette and font:
|
|
|
|
|
|
```r
|
|
|
# Define color palette and formatting
|
|
|
color_green <- "#608C32"
|
|
|
color_blue <- "#0063A7"
|
|
|
color_black <- "black"
|
|
|
color_grey <- "grey50"
|
|
|
font_family <- "sans" # Use a generic sans-serif font
|
|
|
font_size <- 30
|
|
|
axis_label_size <- 30
|
|
|
|
|
|
# Set the theme for all plots
|
|
|
custom_theme <- theme(
|
|
|
text = element_text(family = font_family, size = font_size),
|
|
|
legend.position = "right",
|
|
|
legend.title = element_text(size = axis_label_size, face = "bold"),
|
|
|
legend.text = element_text(size = axis_label_size),
|
|
|
plot.title = element_text(size = font_size + 10, face = "bold", hjust = 0.5, color = color_green)
|
|
|
) |