Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiline plot is not yet documented #2285

Open
rht opened this issue Sep 7, 2024 · 0 comments
Open

Multiline plot is not yet documented #2285

rht opened this issue Sep 7, 2024 · 0 comments

Comments

@rht
Copy link
Contributor

rht commented Sep 7, 2024

What's the problem this feature will solve?
#1941 was merged without documentation because it modified an internal function. It should have public documentation.

Additional context
Example usage for virus on network

page = JupyterViz(
    VirusOnNetwork,
    model_params,
    measures=[
        # This is subject to change, as it could have been
        # {"Infected": {"color": "tab:red"}}, but let's keep it simple.
        {"Infected": "tab:red", "Susceptible": "tab:green", "Resistant": "tab:gray"},
        # Alternatively, if you don't want to manually specify colors:
        # ["Infected", "Susceptible", "Resistant"],
        make_text(get_resistant_susceptible_ratio),
    ],
    name="Virus Model",
    agent_portrayal=agent_portrayal,
)

It should look like this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant