Data

Tools

Indexes

Applications

Experiments

Open Source Science

template_matlab_analysis

A "clean code" template for MATLAB and Octave projects

https://github.com/remi-gau/template_matlab_analysis

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary

Keywords

clean-code matlab octave template
Last synced: 6 months ago · JSON representation ·

Repository

A "clean code" template for MATLAB and Octave projects

Basic Info
Statistics
  • Stars: 6
  • Watchers: 2
  • Forks: 1
  • Open Issues: 1
  • Releases: 1
Topics
clean-code matlab octave template
Created over 5 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Citation

README.md

pre-commit MATLAB: test and coverage Octave: test and coverage codecov pre-commit Documentation Status: latest Binder

Template repository for MATLAB / Octave projects

How to install and use this template

Install with Github

  1. Click the green button Use this template.

  1. Give a name to the repository you want to create. Something short that contains the name of your project: analysis_my_study.

  1. Decide if you want this new repo to be public or private.

  2. Click on Create repository from template

You now have a copy of the template on your Github account. You can then download the code and the pre-set dependencies like this.

  1. Click on green Download button and copy the URL_to_your_repo that is shown there.

  2. Open a terminal and type this:

bash git clone URL_to_your_repo

Install with cookiecutter

Install Cookiecutter:

bash pip install -U cookiecutter

Generate project:

bash cookiecutter https://github.com/Remi-Gau/cookiecutter_matlab_analysis.git

Configuration

Check the CONTRIBUTING.md for more information on setting up this repo.

Owner

  • Name: Remi Gau
  • Login: Remi-Gau
  • Kind: user
  • Location: Louvain la neuve, Belgium
  • Company: Crossmodal perception plasticity lab

Neuroimaging (high-res & laminar fMRI) and multisensory. Too much matlab and presentation and not enough R and python

Citation (CITATION.cff) 

# Check https://citation-file-format.github.io/
# and the schema doc https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
# for more info

cff-version: 1.2.0

title: "FIXME"

version: 0.1.0

abstract: FIXME

message: "If you use this software, please cite it as below."

repository-code: "https://github.com/your_gh_username/FIXME"

contact:
  - email: me@somewhere.com
    family-names: FIXME
    given-names: FIXME

authors:
  - family-names: FIXME
    given-names: FIXME

license: GPL-3.0

keywords:
  - FIXME

GitHub Events

Total
  • Watch event: 2
  • Delete event: 6
  • Issue comment event: 10
  • Push event: 7
  • Pull request review event: 6
  • Pull request event: 12
  • Create event: 10
Last Year
  • Watch event: 2
  • Delete event: 6
  • Issue comment event: 10
  • Push event: 7
  • Pull request review event: 6
  • Pull request event: 12
  • Create event: 10

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 48
  • Average time to close issues: 10 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 2
  • Total pull request authors: 4
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.58
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 46
Past Year
  • Issues: 0
  • Pull requests: 12
  • Average time to close issues: N/A
  • Average time to close pull requests: 14 days
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 1.17
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 12
View more stats
Top Authors
Issue Authors
  • Remi-Gau (8)
  • mgcooper (1)
Pull Request Authors
  • dependabot[bot] (41)
  • pre-commit-ci[bot] (15)
  • github-actions[bot] (4)
  • Remi-Gau (3)
Top Labels
Issue Labels
Pull Request Labels
dependencies (41) github_actions (1)

Dependencies

requirements.txt pypi
  • Sphinx *
  • jupyterlab *
  • miss_hit ==0.9.28
  • myst-parser *
  • octave_kernel *
  • pre-commit *
  • sphinx-copybutton *
  • sphinx_rtd_theme *
  • sphinxcontrib-matlabdomain *
.github/workflows/codespell.yml actions
  • actions/checkout v3 composite
  • codespell-project/actions-codespell master composite
.github/workflows/miss_hit.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/octave_test_and_coverage.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • joergbrech/moxunit-action v1.2.0 composite
.github/workflows/validate_cff.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/matlab_test_and_coverage.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • matlab-actions/run-command v1.2.3 composite
  • matlab-actions/setup-matlab v1.2.5 composite
binder/environment.yml conda
  • jupyterlab
  • octave_kernel
  • texinfo