https://github.com/Julie-Fabre/prettify_matlab

A one-stop shop to instantly make your MATLAB scripts and plots beautiful, publication-ready and colorblind friendly.
https://github.com/Julie-Fabre/prettify_matlab

Last synced: 3 months ago
JSON representation

A one-stop shop to instantly make your MATLAB scripts and plots beautiful, publication-ready and colorblind friendly.

• Host: GitHub
• URL: https://github.com/Julie-Fabre/prettify_matlab
• Owner: Julie-Fabre
• License: gpl-3.0
• Created: 2023-08-21T13:12:57.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-05T21:02:33.000Z (4 months ago)
• Last Synced: 2024-07-06T02:08:26.096Z (4 months ago)
• Language: MATLAB
• Homepage:
• Size: 5.04 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_science - Plot beautifier - MATLAB

README

        
[![View prettify_matlab on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://uk.mathworks.com/matlabcentral/fileexchange/154567-prettify_matlab)

# 🪄 prettify matlab

A one-stop shop to instantly make your MATLAB scripts and plots beautiful, publication-ready and colorblind friendly.

## 🏁 Installation

To use prettify_matlab:

- clone the repository and it's dependancies 

- add the repository folder to MATLAB's path.

prettify_matlab doesn't use any of MATLAB's add-on toolboxes.

### Dependencies 

- [colorbrewer](https://github.com/DrosteEffect/BrewerMap), to generate colormaps 

- [rgb](https://uk.mathworks.com/matlabcentral/fileexchange/1805-rgb-m) - modified version (called with `prettify_rgb()`) already included. 

## :triangular_flag_on_post: Features     

### Prettify code

Run `prettify_current_code;` to prettify your current script open in the MATLAB editor. All code editing rules are stored in the `formatRules.xml` file, where they can easily be changed.



### Prettify plots

Run `prettify_plot;` to prettify your current figure (includes all subplots). Includes options to modify the background color, text size and homogenize x and y limits across plots. 



### Prettify colors

#### Colorblind simulator 

Run `prettify_colorblind_simulator;` to plot your current figure as it would seen with different types of color blindness.

Uses the matrices from:  

> Gustavo M. Machado, Manuel M. Oliveira, and Leandro A. F. Fernandes "A Physiologically-based Model for Simulation of Color Vision Deficiency". IEEE Transactions on Visualization and Computer Graphics. Volume 15 (2009), Number 6, November/December 2009. pp. 1291-1298.

![cb](https://github.com/Julie-Fabre/prettify_matlab/assets/29582008/6ca9b2c6-5560-45f3-8f1b-767f9ce37965)

### 🤗 Support and citing

If you find this repo useful in your work, we would like a citation [more details coming soon-ish]. Contact us for more information. Cheers! 

#### To do list 

- [ ] Perceptually-uniform, colorblind friendly colormaps.

- [ ] Prettify colorbars and labels

- [ ] wrap titles/labels 

- [ ] shaded, shaded gradual