build based on bf03b37

codedthinking · Jul 3, 2024 · 8d8f5b5 · 8d8f5b5
1 parent b6a126c
commit 8d8f5b5
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-03T06:49:14","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-03T08:17:39","documenter_version":"1.5.0"}}
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/reference/index.html b/dev/reference/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Reference · Kezdi.jl</title><meta name="title" content="Reference · Kezdi.jl"/><meta property="og:title" content="Reference · Kezdi.jl"/><meta property="twitter:title" content="Reference · Kezdi.jl"/><meta name="description" content="Documentation for Kezdi.jl."/><meta property="og:description" content="Documentation for Kezdi.jl."/><meta property="twitter:description" content="Documentation for Kezdi.jl."/><meta property="og:url" content="https://codedthinking.github.io/Kezdi.jl/reference/"/><meta property="twitter:url" content="https://codedthinking.github.io/Kezdi.jl/reference/"/><link rel="canonical" href="https://codedthinking.github.io/Kezdi.jl/reference/"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="Kezdi.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Kezdi.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="../">Home</a></li><li class="is-active"><a class="tocitem" href>Reference</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>Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/codedthinking/Kezdi.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/codedthinking/Kezdi.jl/blob/main/docs/src/reference.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"><ul><li><a href="#Kezdi.@collapse-Tuple"><code>Kezdi.@collapse</code></a></li><li><a href="../#Kezdi.@collapse"><code>Kezdi.@collapse</code></a></li><li><a href="#Kezdi.@count-Tuple"><code>Kezdi.@count</code></a></li><li><a href="../#Kezdi.@drop"><code>Kezdi.@drop</code></a></li><li><a href="#Kezdi.@drop-Tuple"><code>Kezdi.@drop</code></a></li><li><a href="#Kezdi.@egen-Tuple"><code>Kezdi.@egen</code></a></li><li><a href="../#Kezdi.@egen"><code>Kezdi.@egen</code></a></li><li><a href="#Kezdi.@generate-Tuple"><code>Kezdi.@generate</code></a></li><li><a href="../#Kezdi.@generate"><code>Kezdi.@generate</code></a></li><li><a href="#Kezdi.@keep-Tuple"><code>Kezdi.@keep</code></a></li><li><a href="../#Kezdi.@keep"><code>Kezdi.@keep</code></a></li><li><a href="../#Kezdi.@regress"><code>Kezdi.@regress</code></a></li><li><a href="#Kezdi.@regress-Tuple"><code>Kezdi.@regress</code></a></li><li><a href="../#Kezdi.@replace"><code>Kezdi.@replace</code></a></li><li><a href="#Kezdi.@replace-Tuple"><code>Kezdi.@replace</code></a></li><li><a href="#Kezdi.@summarize-Tuple"><code>Kezdi.@summarize</code></a></li><li><a href="../#Kezdi.@summarize"><code>Kezdi.@summarize</code></a></li><li><a href="#Kezdi.@tabulate-Tuple"><code>Kezdi.@tabulate</code></a></li><li><a href="../#Kezdi.@tabulate"><code>Kezdi.@tabulate</code></a></li><li><a href="../#Kezdi.With.@with"><code>Kezdi.With.@with</code></a></li></ul><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="Kezdi.@collapse-Tuple" href="#Kezdi.@collapse-Tuple"><code>Kezdi.@collapse</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@collapse df y1 = expr1 y2 = expr2 ... [@if condition], [by(group1, group2, ...)]</code></pre><p>Collapse <code>df</code> by evaluating expressions <code>expr1</code>, <code>expr2</code>, etc. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true. If <code>by</code> is provided, the operation is executed by group.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L55-L59">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="Kezdi.@count-Tuple" href="#Kezdi.@count-Tuple"><code>Kezdi.@count</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@count df [@if condition]</code></pre><p>Count the number of rows for which the condition is true. If <code>condition</code> is not provided, the total number of rows is counted.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L91-L95">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="Kezdi.@drop-Tuple" href="#Kezdi.@drop-Tuple"><code>Kezdi.@drop</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@drop df y1 y2 ...</code></pre><p>or     @drop df [@if condition]    </p><p>Drop the variables <code>y1</code>, <code>y2</code>, etc. from <code>df</code>. If <code>condition</code> is provided, the rows for which the condition is true are dropped.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L17-L23">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="Kezdi.@egen-Tuple" href="#Kezdi.@egen-Tuple"><code>Kezdi.@egen</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@egen df y1 = expr1 y2 = expr2 ... [@if condition], [by(group1, group2, ...)]</code></pre><p>Generate new variables in <code>df</code> by evaluating expressions <code>expr1</code>, <code>expr2</code>, etc. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true. When the condition is false, the variables will be missing. If <code>by</code> is provided, the operation is executed by group.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L46-L50">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="Kezdi.@generate-Tuple" href="#Kezdi.@generate-Tuple"><code>Kezdi.@generate</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@generate df y = expr [@if condition]</code></pre><p>Create a new variable <code>y</code> in <code>df</code> by evaluating <code>expr</code>. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true. When the condition is false, the variable will be missing. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L28-L32">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="Kezdi.@keep-Tuple" href="#Kezdi.@keep-Tuple"><code>Kezdi.@keep</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@keep df y1 y2 ... [@if condition]</code></pre><p>Keep only the variables <code>y1</code>, <code>y2</code>, etc. in <code>df</code>. If <code>condition</code> is provided, only the rows for which the condition is true are kept.  </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L8-L12">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="Kezdi.@regress-Tuple" href="#Kezdi.@regress-Tuple"><code>Kezdi.@regress</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@regress df y x1 x2 ... [@if condition], [robust] [cluster(var1, var2, ...)]</code></pre><p>Estimate a regression model in <code>df</code> with dependent variable <code>y</code> and independent variables <code>x1</code>, <code>x2</code>, etc. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true. If <code>robust</code> is provided, robust standard errors are calculated. If <code>cluster</code> is provided, clustered standard errors are calculated.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L73-L77">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="Kezdi.@replace-Tuple" href="#Kezdi.@replace-Tuple"><code>Kezdi.@replace</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@replace df y = expr [@if condition]</code></pre><p>Replace the values of <code>y</code> in <code>df</code> with the result of evaluating <code>expr</code>. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true. When the condition is false, the variable will be left unchanged.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L37-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="Kezdi.@summarize-Tuple" href="#Kezdi.@summarize-Tuple"><code>Kezdi.@summarize</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@summarize df y [@if condition]</code></pre><p>Summarize the variable <code>y</code> in <code>df</code>. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L64-L68">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="Kezdi.@tabulate-Tuple" href="#Kezdi.@tabulate-Tuple"><code>Kezdi.@tabulate</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@tabulate df y1 y2 ... [@if condition]</code></pre><p>Create a frequency table for the variables <code>y1</code>, <code>y2</code>, etc. in <code>df</code>. If <code>condition</code> is provided, the operation is executed only on rows for which the condition is true.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/codedthinking/Kezdi.jl/blob/bf03b37caf81b57e32b3e4a2359c2e3bd06b9e33/src/macros.jl#L82-L86">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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.5.0 on <span class="colophon-date" title="Wednesday 3 July 2024 08:17">Wednesday 3 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>