{"id":26096451,"url":"https://github.com/projecttorreypines/helpplots.jl","last_synced_at":"2026-03-07T08:32:09.003Z","repository":{"id":279878688,"uuid":"940213427","full_name":"ProjectTorreyPines/HelpPlots.jl","owner":"ProjectTorreyPines","description":"Print keywords arguments help for plot(...) function calls","archived":false,"fork":false,"pushed_at":"2025-11-24T13:18:44.000Z","size":359,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-12-16T13:22:23.254Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://projecttorreypines.github.io/HelpPlots.jl/dev","language":"Julia","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProjectTorreyPines.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-27T19:50:47.000Z","updated_at":"2025-03-12T05:25:46.000Z","dependencies_parsed_at":"2025-02-28T08:46:27.512Z","dependency_job_id":"5828f542-10a3-45b1-95c7-3038717bdfd1","html_url":"https://github.com/ProjectTorreyPines/HelpPlots.jl","commit_stats":null,"previous_names":["projecttorreypines/helpplots.jl"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ProjectTorreyPines/HelpPlots.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectTorreyPines%2FHelpPlots.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectTorreyPines%2FHelpPlots.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectTorreyPines%2FHelpPlots.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectTorreyPines%2FHelpPlots.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProjectTorreyPines","download_url":"https://codeload.github.com/ProjectTorreyPines/HelpPlots.jl/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjectTorreyPines%2FHelpPlots.jl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-09T14:56:02.201Z","updated_at":"2026-03-07T08:32:08.971Z","avatar_url":"https://github.com/ProjectTorreyPines.png","language":"Julia","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HelpPlots.jl\n\n[![Build Status](https://github.com/mgyoo86/HelpPlots.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/mgyoo86/HelpPlots.jl/actions/workflows/CI.yml?query=branch%3Amain)\n\n## About the Package\n\n`HelpPlots.jl` provides simple utilities to enhance the `@recipe` functionality in `Plots.jl`. It checks the correctness of keyword arguments and displays helpful information so that users can fine-tune their plots. This functionality was originally developed by **Orso Meneghini** and has been extracted into a lightweight, standalone package.\n\n## Note\n\nThis package is designed to be independent and lightweight, without strict dependencies on other packages (e.g., it is independent of the `FUSE.jl` ecosystem). However, to use the `help_plot` and `help_plot!` functionalities provided by `HelpPlots.jl`, users must also load the `Plots.jl` package.\n\n## Examples\nOne can define keyword information inside `@recipe` using `assert_type_and_record_argument` function provided by `HelpPlots.jl` package, like the following example:\n```julia\nusing HelpPlots\n\n# FYI, this recipe is defined in `SimulationParameters.jl` package\n@recipe function plot_GroupedParameters(GPs::Vector{GroupedParameter}; nrows=:auto, ncols=:auto, each_size=(500, 400))\n\n    id = recipe_dispatch(GPs)\n    assert_type_and_record_argument(id, Tuple{Integer,Integer}, \"Size of each subplot. (Default=(500, 400))\"; each_size)\n    assert_type_and_record_argument(id, Union{Integer,Symbol}, \"Number of rows for subplots' layout (Default = :auto)\"; nrows)\n    assert_type_and_record_argument(id, Union{Integer,Symbol}, \"Number of columns for subplots' layout (Default = :auto)\"; ncols)\n\n    # Main body of recipe\n    ...\n    ...\n    @series begin\n        ...\n        ...\n    end\nend\n```\n\nThe following examples illustrate how `help_plot` works. See `test/runtests.jl` and `test/my_recipes.jl` for more details.\n\n```julia\n# Suppose you have some data and an associated @recipe.\n# The following example assumes that you have `inis` and `inis2` as your data,\n# and that you are using an @recipe defined in the `SimulationParameters.jl` package.\n\n# This will plot the figure and display the available keyword information.\nhelp_plot(inis)\n\n# This will overlay on the current figure and display the available keyword information.\nhelp_plot!(inis2)\n```\n\nThe keyword information is printed like the following.\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"assets/example_1.png\" width=100%\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nThe help_plot function checks the validity of keyword arguments and informs the user if a given keyword is incorrect.\nFor example:\n```julia\n# The following call will fail because `each_size` is expected to be a Tuple{Integer, Integer}\nhelp_plot(inis, each_size=123.456)\n\n```\nIn such a case, `help_plot` produces an error message to guide the user in fixing the keyword.\n\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"assets/example_2.png\" width=100%\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojecttorreypines%2Fhelpplots.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojecttorreypines%2Fhelpplots.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojecttorreypines%2Fhelpplots.jl/lists"}