build based on 09bdfdc

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-16T01:23:31","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-17T01:06:32","documenter_version":"1.7.0"}}

dev/api/data/index.html

@@ -48,4 +48,4 @@
   > posterior
 
 julia> to_netcdf(idata, "data.nc")
-&quot;data.nc&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/io.jl#L63-L92">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../diagnostics/">« Diagnostics</a><a class="docs-footer-nextpage" href="../inference_data/">InferenceData »</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.7.0 on <span class="colophon-date" title="Monday 16 September 2024 01:23">Monday 16 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+&quot;data.nc&quot;</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/io.jl#L63-L92">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../diagnostics/">« Diagnostics</a><a class="docs-footer-nextpage" href="../inference_data/">InferenceData »</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.7.0 on <span class="colophon-date" title="Tuesday 17 September 2024 01:06">Tuesday 17 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/api/dataset/index.html

@@ -10,4 +10,4 @@
     data::NamedTuple,
     dims::Tuple{Vararg{DimensionalData.Dimension}};
     metadata=DimensionalData.NoMetadata(),
-)</code></pre><p>In most cases, use <a href="#InferenceObjects.convert_to_dataset"><code>convert_to_dataset</code></a> to create a <code>Dataset</code> instead of directly using a constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/dataset.jl#L1-L27">source</a></section></article><h2 id="General-conversion"><a class="docs-heading-anchor" href="#General-conversion">General conversion</a><a id="General-conversion-1"></a><a class="docs-heading-anchor-permalink" href="#General-conversion" title="Permalink"></a></h2><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="InferenceObjects.convert_to_dataset" href="#InferenceObjects.convert_to_dataset"><code>InferenceObjects.convert_to_dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert_to_dataset(obj; group = :posterior, kwargs...) -&gt; Dataset</code></pre><p>Convert a supported object to a <code>Dataset</code>.</p><p>In most cases, this function calls <a href="../inference_data/#InferenceObjects.convert_to_inference_data"><code>convert_to_inference_data</code></a> and returns the corresponding <code>group</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/convert_dataset.jl#L4-L11">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="InferenceObjects.namedtuple_to_dataset" href="#InferenceObjects.namedtuple_to_dataset"><code>InferenceObjects.namedtuple_to_dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">namedtuple_to_dataset(data; kwargs...) -&gt; Dataset</code></pre><p>Convert <code>NamedTuple</code> mapping variable names to arrays to a <a href="#InferenceObjects.Dataset"><code>Dataset</code></a>.</p><p>Any non-array values will be converted to a 0-dimensional array.</p><p><strong>Keywords</strong></p><ul><li><code>attrs::AbstractDict{&lt;:AbstractString}</code>: a collection of metadata to attach to the dataset, in addition to defaults. Values should be JSON serializable.</li><li><code>library::Union{String,Module}</code>: library used for performing inference. Will be attached to the <code>attrs</code> metadata.</li><li><code>dims</code>: a collection mapping variable names to collections of objects containing dimension names. Acceptable such objects are:<ul><li><code>Symbol</code>: dimension name</li><li><code>Type{&lt;:DimensionsionalData.Dimension}</code>: dimension type</li><li><code>DimensionsionalData.Dimension</code>: dimension, potentially with indices</li><li><code>Nothing</code>: no dimension name provided, dimension name is automatically generated</li></ul></li><li><code>coords</code>: a collection indexable by dimension name specifying the indices of the given dimension. If indices for a dimension in <code>dims</code> are provided, they are used even if the dimension contains its own indices. If a dimension is missing, its indices are automatically generated.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/dataset.jl#L54-L77">source</a></section></article><h2 id="DimensionalData"><a class="docs-heading-anchor" href="#DimensionalData">DimensionalData</a><a id="DimensionalData-1"></a><a class="docs-heading-anchor-permalink" href="#DimensionalData" title="Permalink"></a></h2><p>As a <code>DimensionalData.AbstractDimStack</code>, <code>Dataset</code> also implements the <code>AbstractDimStack</code> API and can be used like a <code>DimStack</code>. See <a href="https://rafaqz.github.io/DimensionalData.jl/stable/">DimensionalData&#39;s documentation</a> for example usage.</p><h2 id="Tables-inteface"><a class="docs-heading-anchor" href="#Tables-inteface">Tables inteface</a><a id="Tables-inteface-1"></a><a class="docs-heading-anchor-permalink" href="#Tables-inteface" title="Permalink"></a></h2><p><code>Dataset</code> implements the <a href="https://github.com/JuliaData/Tables.jl">Tables</a> interface. This allows <code>Dataset</code>s to be used as sources for any function that can accept a table. For example, it&#39;s straightforward to:</p><ul><li>write to CSV with CSV.jl</li><li>flatten to a DataFrame with DataFrames.jl</li><li>plot with StatsPlots.jl</li><li>plot with AlgebraOfGraphics.jl</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../inference_data/">« InferenceData</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.7.0 on <span class="colophon-date" title="Monday 16 September 2024 01:23">Monday 16 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><p>In most cases, use <a href="#InferenceObjects.convert_to_dataset"><code>convert_to_dataset</code></a> to create a <code>Dataset</code> instead of directly using a constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/dataset.jl#L1-L27">source</a></section></article><h2 id="General-conversion"><a class="docs-heading-anchor" href="#General-conversion">General conversion</a><a id="General-conversion-1"></a><a class="docs-heading-anchor-permalink" href="#General-conversion" title="Permalink"></a></h2><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="InferenceObjects.convert_to_dataset" href="#InferenceObjects.convert_to_dataset"><code>InferenceObjects.convert_to_dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">convert_to_dataset(obj; group = :posterior, kwargs...) -&gt; Dataset</code></pre><p>Convert a supported object to a <code>Dataset</code>.</p><p>In most cases, this function calls <a href="../inference_data/#InferenceObjects.convert_to_inference_data"><code>convert_to_inference_data</code></a> and returns the corresponding <code>group</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/convert_dataset.jl#L4-L11">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="InferenceObjects.namedtuple_to_dataset" href="#InferenceObjects.namedtuple_to_dataset"><code>InferenceObjects.namedtuple_to_dataset</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">namedtuple_to_dataset(data; kwargs...) -&gt; Dataset</code></pre><p>Convert <code>NamedTuple</code> mapping variable names to arrays to a <a href="#InferenceObjects.Dataset"><code>Dataset</code></a>.</p><p>Any non-array values will be converted to a 0-dimensional array.</p><p><strong>Keywords</strong></p><ul><li><code>attrs::AbstractDict{&lt;:AbstractString}</code>: a collection of metadata to attach to the dataset, in addition to defaults. Values should be JSON serializable.</li><li><code>library::Union{String,Module}</code>: library used for performing inference. Will be attached to the <code>attrs</code> metadata.</li><li><code>dims</code>: a collection mapping variable names to collections of objects containing dimension names. Acceptable such objects are:<ul><li><code>Symbol</code>: dimension name</li><li><code>Type{&lt;:DimensionsionalData.Dimension}</code>: dimension type</li><li><code>DimensionsionalData.Dimension</code>: dimension, potentially with indices</li><li><code>Nothing</code>: no dimension name provided, dimension name is automatically generated</li></ul></li><li><code>coords</code>: a collection indexable by dimension name specifying the indices of the given dimension. If indices for a dimension in <code>dims</code> are provided, they are used even if the dimension contains its own indices. If a dimension is missing, its indices are automatically generated.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/arviz-devs/InferenceObjects.jl/blob/v0.4.3/src/dataset.jl#L54-L77">source</a></section></article><h2 id="DimensionalData"><a class="docs-heading-anchor" href="#DimensionalData">DimensionalData</a><a id="DimensionalData-1"></a><a class="docs-heading-anchor-permalink" href="#DimensionalData" title="Permalink"></a></h2><p>As a <code>DimensionalData.AbstractDimStack</code>, <code>Dataset</code> also implements the <code>AbstractDimStack</code> API and can be used like a <code>DimStack</code>. See <a href="https://rafaqz.github.io/DimensionalData.jl/stable/">DimensionalData&#39;s documentation</a> for example usage.</p><h2 id="Tables-inteface"><a class="docs-heading-anchor" href="#Tables-inteface">Tables inteface</a><a id="Tables-inteface-1"></a><a class="docs-heading-anchor-permalink" href="#Tables-inteface" title="Permalink"></a></h2><p><code>Dataset</code> implements the <a href="https://github.com/JuliaData/Tables.jl">Tables</a> interface. This allows <code>Dataset</code>s to be used as sources for any function that can accept a table. For example, it&#39;s straightforward to:</p><ul><li>write to CSV with CSV.jl</li><li>flatten to a DataFrame with DataFrames.jl</li><li>plot with StatsPlots.jl</li><li>plot with AlgebraOfGraphics.jl</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../inference_data/">« InferenceData</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.7.0 on <span class="colophon-date" title="Tuesday 17 September 2024 01:06">Tuesday 17 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>