-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jun 13, 2024
1 parent
7ff015e
commit 10dcb97
Showing
22 changed files
with
232 additions
and
402 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Display · JudiLing.jl</title><link rel="canonical" href="https://MegamindHenry.github.io/JudiLing.jl/man/display/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-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">JudiLing.jl</span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../input/">Loading data</a></li><li><a class="tocitem" href="../make_cue_matrix/">Make Cue Matrix</a></li><li><a class="tocitem" href="../make_semantic_matrix/">Make Semantic Matrix</a></li><li><a class="tocitem" href="../cholesky/">Cholesky</a></li><li><a class="tocitem" href="../make_adjacency_matrix/">Make Adjacency Matrix</a></li><li><a class="tocitem" href="../make_yt_matrix/">Make Yt Matrix</a></li><li><a class="tocitem" href="../find_path/">Find Paths</a></li><li><a class="tocitem" href="../eval/">Evaluation</a></li><li><a class="tocitem" href="../output/">Output</a></li><li><a class="tocitem" href="../test_combo/">Test Combo</a></li><li class="is-active"><a class="tocitem" href>Display</a></li><li><a class="tocitem" href="../utils/">Utils</a></li><li><a class="tocitem" href="../pickle/">Pickle</a></li><li><a class="tocitem" href="../pyndl/">Pyndl</a></li><li><a class="tocitem" href="../wh/">Widrow-Hoff Learning</a></li></ul></li><li><a class="tocitem" href="../all_manual/">All Manual index</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Manual</a></li><li class="is-active"><a href>Display</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Display</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/MegamindHenry/JudiLing.jl/blob/master/docs/src/man/display.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Cholesky"><a class="docs-heading-anchor" href="#Cholesky">Cholesky</a><a id="Cholesky-1"></a><a class="docs-heading-anchor-permalink" href="#Cholesky" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="JudiLing.display_matrix-Tuple{Any, Any, Any}" href="#JudiLing.display_matrix-Tuple{Any, Any, Any}"><code>JudiLing.display_matrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">display_matrix(M, rownames, colnames)</code></pre><p>Display matrix with rownames and colnames.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MegamindHenry/JudiLing.jl/blob/bc90b87cb8b3fb1b3072edc115b53d661b947f2b/src/display.jl#LL1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="JudiLing.display_matrix-NTuple{5, Any}" href="#JudiLing.display_matrix-NTuple{5, Any}"><code>JudiLing.display_matrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">display_matrix(data, target_col, cue_obj, M, M_type)</code></pre><p>Display matrix with rownames and colnames.</p><p><strong>Obligatory Arguments</strong></p><ul><li><code>data::DataFrame</code>: the dataset</li><li><code>target_col::Union{String, Symbol}</code>: the target column name</li><li><code>cue_obj::Cue_Matrix_Struct</code>: the cue matrix structure</li><li><code>M::Union{SparseMatrixCSC, Matrix}</code>: the matrix</li><li><code>M_type::Union{String, Symbol}</code>: the type of the matrix, currently support :C, :S, :F, :G, :Chat, :Shat, :A and :R</li></ul><p><strong>Optional Arguments</strong></p><ul><li><code>nrow::Int64 = 6</code>: the number of rows to display</li><li><code>ncol::Int64 = 6</code>: the number of columns to display</li><li><code>return_matrix::Bool = false</code>: whether the created dataframe should be returned (and not only displayed)</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia">JudiLing.display_matrix(latin, :Word, cue_obj, cue_obj.C, :C) | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Display · JudiLing.jl</title><link rel="canonical" href="https://quantling.github.io/JudiLing.jl/man/display/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-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">JudiLing.jl</span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../input/">Loading data</a></li><li><a class="tocitem" href="../make_cue_matrix/">Make Cue Matrix</a></li><li><a class="tocitem" href="../make_semantic_matrix/">Make Semantic Matrix</a></li><li><a class="tocitem" href="../cholesky/">Cholesky</a></li><li><a class="tocitem" href="../make_adjacency_matrix/">Make Adjacency Matrix</a></li><li><a class="tocitem" href="../make_yt_matrix/">Make Yt Matrix</a></li><li><a class="tocitem" href="../find_path/">Find Paths</a></li><li><a class="tocitem" href="../eval/">Evaluation</a></li><li><a class="tocitem" href="../output/">Output</a></li><li><a class="tocitem" href="../test_combo/">Test Combo</a></li><li class="is-active"><a class="tocitem" href>Display</a></li><li><a class="tocitem" href="../utils/">Utils</a></li><li><a class="tocitem" href="../pickle/">Pickle</a></li><li><a class="tocitem" href="../pyndl/">Pyndl</a></li><li><a class="tocitem" href="../wh/">Widrow-Hoff Learning</a></li><li><a class="tocitem" href="../deep_learning/">Deep learning</a></li><li><a class="tocitem" href="../measures_func/">Measures function</a></li></ul></li><li><a class="tocitem" href="../all_manual/">All Manual index</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Manual</a></li><li class="is-active"><a href>Display</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Display</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/quantling/JudiLing.jl/blob/master/docs/src/man/display.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Cholesky"><a class="docs-heading-anchor" href="#Cholesky">Cholesky</a><a id="Cholesky-1"></a><a class="docs-heading-anchor-permalink" href="#Cholesky" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="JudiLing.display_matrix-Tuple{Any, Any, Any}" href="#JudiLing.display_matrix-Tuple{Any, Any, Any}"><code>JudiLing.display_matrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">display_matrix(M, rownames, colnames)</code></pre><p>Display matrix with rownames and colnames.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantling/JudiLing.jl/blob/a96303107984a8cec21f2a3352c8b91ec65373bf/src/display.jl#LL1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="JudiLing.display_matrix-NTuple{5, Any}" href="#JudiLing.display_matrix-NTuple{5, Any}"><code>JudiLing.display_matrix</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">display_matrix(data, target_col, cue_obj, M, M_type)</code></pre><p>Display matrix with rownames and colnames.</p><p><strong>Obligatory Arguments</strong></p><ul><li><code>data::DataFrame</code>: the dataset</li><li><code>target_col::Union{String, Symbol}</code>: the target column name</li><li><code>cue_obj::Cue_Matrix_Struct</code>: the cue matrix structure</li><li><code>M::Union{SparseMatrixCSC, Matrix}</code>: the matrix</li><li><code>M_type::Union{String, Symbol}</code>: the type of the matrix, currently support :C, :S, :F, :G, :Chat, :Shat, :A and :R</li></ul><p><strong>Optional Arguments</strong></p><ul><li><code>nrow::Int64 = 6</code>: the number of rows to display</li><li><code>ncol::Int64 = 6</code>: the number of columns to display</li><li><code>return_matrix::Bool = false</code>: whether the created dataframe should be returned (and not only displayed)</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia">JudiLing.display_matrix(latin, :Word, cue_obj, cue_obj.C, :C) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, S, :S) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, G, :G) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, Chat, :Chat) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, F, :F) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, Shat, :Shat) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, A, :A) | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, R, :R)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MegamindHenry/JudiLing.jl/blob/bc90b87cb8b3fb1b3072edc115b53d661b947f2b/src/display.jl#LL23-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../test_combo/">« Test Combo</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Monday 20 May 2024 16:05">Monday 20 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| JudiLing.display_matrix(latin, :Word, cue_obj, R, :R)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantling/JudiLing.jl/blob/a96303107984a8cec21f2a3352c8b91ec65373bf/src/display.jl#LL23-L51">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../test_combo/">« Test Combo</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Thursday 13 June 2024 13:27">Thursday 13 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.