/reproducible_matlab

Produces slides for a talk on reproducible MATLAB

Primary LanguageMATLABCreative Commons Attribution Share Alike 4.0 InternationalCC-BY-SA-4.0

How to make MATLAB projects more reproducible and shareable ♻️

Slides for a talk on reproducible MATLAB projects.

Events

Events that this talk has been presented at:

Using these slides

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Contributing

I welcome contributions to these slides, please make a fork of this repository, make your changes and open a pull request against this repo.

Rendering the slides locally

These slides are produced using Quarto.

In order to render them locally, you will need to install Quarto from https://quarto.org/docs/get-started/.

Quarto documents can be rendered in either:

  • VSCode
  • RStudio (> 2022.07.1+554)
  • Jupyter
  • Terminal

Full instructions can be found at the link above, however in brief:

  • In RStudio, open index.qmd, above the document click Render
  • In the terminal, run quarto render

Reproducing plot(s)

Dependencies

  • MATLAB (most modern versions should work, though only version R2022a is tested)
  1. Clone this repository (instructions here for MATLAB)
  2. Install any uninstalled dependencies, above.
  3. Load the project file (reproducible_matlab.prj, by double-clicking in MATLAB)
  4. Run the function plot_matlab_publications to process data and plot figure.