iiasa / iiasa/message_ix

Use consistent code style in R-tutorial notebooks

Open
#378 1 comment 0 reactions 0 assignees View on GitHub
docs good first issue help wanted
Dominant language
Jupyter Notebook
Stars
150
Forks
178
Avg merge
17h 32m
Merged PRs (30d)
2

Description

Working on #377, I noticed that the code in the R tutorials (at least) is not consistently formatted.

Well-formatted code increases readability, which is critical for new users. In contrast, inconsistently-formatted code adds the (avoidable) difficulty of reading the code to the (inevitable) challenge of learning the core concepts of the modeling framework.

Choose a style guide and ensure all code in the tutorial notebooks conform to it.

Contributor guide

Open the contributing guide

Research direction

Locate the R tutorial notebooks referenced in the issue and review their current formatting alongside the project context from #377. Choose and document a consistent style guide, then apply it across the R tutorial code; done means all code in those notebooks follows the selected style consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, r
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.