build based on 3ca3f8d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-14T16:06:38","documenter_version":"1.8.1"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-14T16:13:41","documenter_version":"1.8.1"}}

dev/index.html

@@ -35,4 +35,4 @@
  4.757247582108903
  6.670866154143596</code></pre><p>For a more detailed guide of how to compute ground truth conditional distributions please refer to <a href="man/ground-truth/">Computing Ground Truth Conditional Distributions</a>.</p><h3 id="Wrapping-an-existing-Table-as-a-CausalTable"><a class="docs-heading-anchor" href="#Wrapping-an-existing-Table-as-a-CausalTable">Wrapping an existing Table as a CausalTable</a><a id="Wrapping-an-existing-Table-as-a-CausalTable-1"></a><a class="docs-heading-anchor-permalink" href="#Wrapping-an-existing-Table-as-a-CausalTable" title="Permalink"></a></h3><p>If you have a table of data that you would like to use with CausalTables.jl without defining a corresponding DataGeneratingProcess (i.e. to use with another package, or write your own causal method in Julia) you can wrap it as a <code>CausalTable</code> using the corresponding constructor.</p><pre><code class="language-julia hljs">tbl = (W = rand(1:5, 10), X = randn(10), Y = randn(10))
 ctbl = CausalTable(tbl; treatment = :X, response = :Y, 
-                        causes = (X = [:W], Y = [:W, :X]))</code></pre><p>Observe how <code>causes</code> is a <code>NamedTuple</code> of arrays listing the causes of specified variables, forming a partial edgelist of a <a href="https://en.wikipedia.org/wiki/Directed_acyclic_graph">directed acyclic graph</a>. Labeling the causes of treatment and response is required, but causes of other variables do not need to be labeled; the roles of common causal inference variables, such as confounders, can be determined automatically. </p><p>Wrapping data as a <code>CausalTable</code> allows one to use its utility functions to extract causal-relevant variables from the dataset. For instance, you can extract the treatment, response, confounders, mediators, or instruments from the dataset using the corresponding functions. As an example, the following subsets the data to include only confounders:</p><pre><code class="language-julia hljs">confounders(ctbl)</code></pre><p>For a more detailed guide of how to wrap an existing table as a CausalTable please refer to <a href="man/formatting/">Turning Your Data Into a CausalTable</a>.</p><h1 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h1><p>Have questions? Spot a bug or issue in the documentation? Want to request a new feature or add one yourself? Please don&#39;t hesitate to open an issue or pull request on the <a href="https://github.com/salbalkus/CausalTables.jl">CausalTables.jl GitHub repository</a>. We welcome all contributions and feedback!</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/formatting/">Turning data into a <code>CausalTable</code> »</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.1 on <span class="colophon-date" title="Friday 14 February 2025 16:06">Friday 14 February 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                        causes = (X = [:W], Y = [:W, :X]))</code></pre><p>Observe how <code>causes</code> is a <code>NamedTuple</code> of arrays listing the causes of specified variables, forming a partial edgelist of a <a href="https://en.wikipedia.org/wiki/Directed_acyclic_graph">directed acyclic graph</a>. Labeling the causes of treatment and response is required, but causes of other variables do not need to be labeled; the roles of common causal inference variables, such as confounders, can be determined automatically. </p><p>Wrapping data as a <code>CausalTable</code> allows one to use its utility functions to extract causal-relevant variables from the dataset. For instance, you can extract the treatment, response, confounders, mediators, or instruments from the dataset using the corresponding functions. As an example, the following subsets the data to include only confounders:</p><pre><code class="language-julia hljs">confounders(ctbl)</code></pre><p>For a more detailed guide of how to wrap an existing table as a CausalTable please refer to <a href="man/formatting/">Turning Your Data Into a CausalTable</a>.</p><h1 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h1><p>Have questions? Spot a bug or issue in the documentation? Want to request a new feature or add one yourself? Please don&#39;t hesitate to open an issue or pull request on the <a href="https://github.com/salbalkus/CausalTables.jl">CausalTables.jl GitHub repository</a>. We welcome all contributions and feedback!</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/formatting/">Turning data into a <code>CausalTable</code> »</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.1 on <span class="colophon-date" title="Friday 14 February 2025 16:13">Friday 14 February 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>