Skip to content

Commit

Permalink
build based on bd3fae9
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 20, 2024
1 parent dd713ad commit b3a2a5e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion previews/PR5/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-20T14:42:19","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-20T15:05:53","documenter_version":"1.8.0"}}
4 changes: 2 additions & 2 deletions previews/PR5/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API / DocStrings · ERPExplorer.jl</title><meta name="title" content="API / DocStrings · ERPExplorer.jl"/><meta property="og:title" content="API / DocStrings · ERPExplorer.jl"/><meta property="twitter:title" content="API / DocStrings · ERPExplorer.jl"/><meta name="description" content="Documentation for ERPExplorer.jl."/><meta property="og:description" content="Documentation for ERPExplorer.jl."/><meta property="twitter:description" content="Documentation for ERPExplorer.jl."/><meta property="og:url" content="https://s-css.github.io/ERPExplorer.jl/api/"/><meta property="twitter:url" content="https://s-css.github.io/ERPExplorer.jl/api/"/><link rel="canonical" href="https://s-css.github.io/ERPExplorer.jl/api/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">ERPExplorer.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">ERPExplorer highlights</a></li><li class="is-active"><a class="tocitem" href>API / DocStrings</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API / DocStrings</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API / DocStrings</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/s-ccs/ERPExplorer.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/s-ccs/ERPExplorer.jl/blob/main/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.create_plot!-NTuple{6, Any}" href="#ERPExplorer.create_plot!-NTuple{6, Any}"><code>ERPExplorer.create_plot!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><ul><li>plots is a spec-api list to push into</li><li>data is the dataframe to be subsetted</li><li>vars contains the levels to be plotted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/0df9e7daf565ee690af778e9ace728abb9036877/src/functions.jl#L105-L109">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.formular_widgets-Tuple{Any}" href="#ERPExplorer.formular_widgets-Tuple{Any}"><code>ERPExplorer.formular_widgets</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">formular_widgets(model_variables)</code></pre><p>Creates widgets to control each variable of a model. Return values:</p><ul><li><code>widget_signal</code>: a signal that emits a dictionary with the current values of the widgets.</li><li><code>formular_widget</code>: The HTML element that can be displayed to interact with the the widgets</li><li><code>value_ranges</code>: A dictionary with the value ranges of each variable.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/0df9e7daf565ee690af778e9ace728abb9036877/src/functions.jl#L33-L41">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.plot_data-NTuple{5, Any}" href="#ERPExplorer.plot_data-NTuple{5, Any}"><code>ERPExplorer.plot_data</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">plot_data(data, value_ranges, categorical_vars, continuous_vars, mapping_obs)
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API / DocStrings · ERPExplorer.jl</title><meta name="title" content="API / DocStrings · ERPExplorer.jl"/><meta property="og:title" content="API / DocStrings · ERPExplorer.jl"/><meta property="twitter:title" content="API / DocStrings · ERPExplorer.jl"/><meta name="description" content="Documentation for ERPExplorer.jl."/><meta property="og:description" content="Documentation for ERPExplorer.jl."/><meta property="twitter:description" content="Documentation for ERPExplorer.jl."/><meta property="og:url" content="https://s-css.github.io/ERPExplorer.jl/api/"/><meta property="twitter:url" content="https://s-css.github.io/ERPExplorer.jl/api/"/><link rel="canonical" href="https://s-css.github.io/ERPExplorer.jl/api/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">ERPExplorer.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">ERPExplorer highlights</a></li><li class="is-active"><a class="tocitem" href>API / DocStrings</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API / DocStrings</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API / DocStrings</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/s-ccs/ERPExplorer.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/s-ccs/ERPExplorer.jl/blob/main/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.create_plot!-NTuple{6, Any}" href="#ERPExplorer.create_plot!-NTuple{6, Any}"><code>ERPExplorer.create_plot!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><ul><li>plots is a spec-api list to push into</li><li>data is the dataframe to be subsetted</li><li>vars contains the levels to be plotted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/bd3fae92db4b1d50507e618020551639cbccc1fe/src/functions.jl#L105-L109">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.formular_widgets-Tuple{Any}" href="#ERPExplorer.formular_widgets-Tuple{Any}"><code>ERPExplorer.formular_widgets</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">formular_widgets(model_variables)</code></pre><p>Creates widgets to control each variable of a model. Return values:</p><ul><li><code>widget_signal</code>: a signal that emits a dictionary with the current values of the widgets.</li><li><code>formular_widget</code>: The HTML element that can be displayed to interact with the the widgets</li><li><code>value_ranges</code>: A dictionary with the value ranges of each variable.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/bd3fae92db4b1d50507e618020551639cbccc1fe/src/functions.jl#L33-L41">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ERPExplorer.plot_data-NTuple{5, Any}" href="#ERPExplorer.plot_data-NTuple{5, Any}"><code>ERPExplorer.plot_data</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">plot_data(data, value_ranges, categorical_vars, continuous_vars, mapping_obs)
- `data`: effects(Dict(...), m)
- `value_ranges`:
- `categorical_vars`:
- `continuous_vars`:
- `mapping`: Dict name=&gt;property</code></pre><p>output ::DataFrames</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/0df9e7daf565ee690af778e9ace728abb9036877/src/functions.jl#L148-L156">source</a></section></article><p>Internally, we use a <code>PlotConfig</code> struct to keep track of common plotting options, so that all functions have a similar API.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« ERPExplorer highlights</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 20 December 2024 14:42">Friday 20 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
- `mapping`: Dict name=&gt;property</code></pre><p>output ::DataFrames</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/s-ccs/ERPExplorer.jl/blob/bd3fae92db4b1d50507e618020551639cbccc1fe/src/functions.jl#L148-L156">source</a></section></article><p>Internally, we use a <code>PlotConfig</code> struct to keep track of common plotting options, so that all functions have a similar API.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« ERPExplorer highlights</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 20 December 2024 15:05">Friday 20 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit b3a2a5e

Please sign in to comment.