Skip to content

Commit

Permalink
build based on 438e43d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 14, 2024
1 parent 479bd7b commit 4c2a5c3
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-02T14:14:46","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-14T16:09:49","documenter_version":"1.2.1"}}
14 changes: 7 additions & 7 deletions dev/datasets/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@
1 │ stat AbstractFloat[8.63372e-6; -2.848… AbstractFloat[-1.0; -1.0 ⋯
5 columns omitted
</code></pre><p>the <code>describe</code> implementation for <code>MultiDataset</code>s will try to find the best <em>statistical measures</em> that can be used to the type of data the modality contains.</p><p>In the example the 2nd modality, which contains variables (just one in the example) of data of type <code>Vector{Float64}</code>, was described by applying the well known 22 features from the package <a href="https://github.com/brendanjohnharris/Catch22.jl">Catch22.jl</a> plus <code>maximum</code>, <code>minimum</code> and <code>mean</code> as the vectors were time series.</p><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="DataAPI.describe" href="#DataAPI.describe"><code>DataAPI.describe</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">describe(md; t = fill([(1, 0, 0)], nmodalities(md)), kwargs...)</code></pre><p>Return descriptive statistics for an <code>AbstractMultiDataset</code> as a <code>Vector</code> of new <code>DataFrame</code>s where each row represents a variable and each column a summary statistic.</p><p><strong>Arguments</strong></p><ul><li><code>md</code>: the <code>AbstractMultiDataset</code>;</li><li><code>t</code>: is a vector of <code>nmodalities</code> elements, where each element is a vector as long as the dimensionality of</li></ul><pre><code class="nohighlight hljs">the i-th modality. Each element of the innermost vector is a tuple
of arguments for [`paa`](@ref).</code></pre><p>For other see the documentation of <a href="#DataAPI.describe"><code>DataFrames.describe</code></a> function.</p><p><strong>Examples</strong></p><p>TODO: examples</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aclai-lab/MultiData.jl/blob/8f883096d43b61304ad4d2f63efbf1d154b29463/src/describe.jl#L70-L88">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../manipulation/">« Manipulation</a><a class="docs-footer-nextpage" href="../utils/">Utils »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 2 February 2024 14:14">Friday 2 February 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
of arguments for [`paa`](@ref).</code></pre><p>For other see the documentation of <a href="#DataAPI.describe"><code>DataFrames.describe</code></a> function.</p><p><strong>Examples</strong></p><p>TODO: examples</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/aclai-lab/MultiData.jl/blob/438e43d9857dcd53701a917d9dac2b04f74664c1/src/describe.jl#L70-L88">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../manipulation/">« Manipulation</a><a class="docs-footer-nextpage" href="../utils/">Utils »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 14 February 2024 16:09">Wednesday 14 February 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/filesystem/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@
1 │ [0.841471, 0.909297, 0.14112, -0…
2 │ [0.540302, -0.416147, -0.989992,…</code></pre><p>Note that each element of a <code>MultiDataset</code> is a <code>SubDataFrame</code>:</p><pre><code class="language-julia-repl hljs">julia&gt; eltype(md)
SubDataFrame
</code></pre><div class="admonition is-info"><header class="admonition-header">Spare variables</header><div class="admonition-body"><p>Spare variables will never be seen when accessing a <code>MultiDataset</code> through its iterator interface. To access them see <a href="manipulation/#MultiData.sparevariables-Tuple{AbstractMultiDataset}"><code>sparevariables</code></a>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="datasets/">Datasets »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 2 February 2024 14:14">Friday 2 February 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><div class="admonition is-info"><header class="admonition-header">Spare variables</header><div class="admonition-body"><p>Spare variables will never be seen when accessing a <code>MultiDataset</code> through its iterator interface. To access them see <a href="manipulation/#MultiData.sparevariables-Tuple{AbstractMultiDataset}"><code>sparevariables</code></a>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="datasets/">Datasets »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 14 February 2024 16:09">Wednesday 14 February 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4c2a5c3

Please sign in to comment.