-
Notifications
You must be signed in to change notification settings - Fork 0
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
Jan 17, 2025
1 parent
84af547
commit 25268cd
Showing
16 changed files
with
1,433 additions
and
0 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"documenter":{"julia_version":"1.8.5","generation_timestamp":"2025-01-17T01:28:24","documenter_version":"1.8.0"}} |
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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · MetidaBioeq.jl</title><meta name="title" content="API · MetidaBioeq.jl"/><meta property="og:title" content="API · MetidaBioeq.jl"/><meta property="twitter:title" content="API · MetidaBioeq.jl"/><meta name="description" content="Documentation for MetidaBioeq.jl."/><meta property="og:description" content="Documentation for MetidaBioeq.jl."/><meta property="twitter:description" content="Documentation for MetidaBioeq.jl."/><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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">MetidaBioeq.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><a class="tocitem" href="../example/">Example</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#API"><span>API</span></a></li></ul></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>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/PharmCat/MetidaBioeq.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/PharmCat/MetidaBioeq.jl/blob/main/docs/src/api.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"><h2 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h2><h3 id="MetidaBioeq.bioequivalence"><a class="docs-heading-anchor" href="#MetidaBioeq.bioequivalence">MetidaBioeq.bioequivalence</a><a id="MetidaBioeq.bioequivalence-1"></a><a class="docs-heading-anchor-permalink" href="#MetidaBioeq.bioequivalence" title="Permalink"></a></h3><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="MetidaBioeq.bioequivalence" href="#MetidaBioeq.bioequivalence"><code>MetidaBioeq.bioequivalence</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">bioequivalence(data; | ||
| vars = nothing, | ||
| subject::Union{String, Symbol}, | ||
| period::Union{String, Symbol, Nothing} = nothing, | ||
| formulation::Union{String, Symbol}, | ||
| sequence::Union{String, Symbol, Nothing} = nothing, | ||
| stage::Union{String, Symbol, Nothing} = nothing, | ||
| reference::Union{String, Symbol, Nothing} = nothing, | ||
| design::Union{String, Symbol, Nothing} = nothing, | ||
| io::IO = stdout, | ||
| seqcheck::Bool = true, | ||
| designcheck::Bool = true, | ||
| dropcheck::Bool = true, | ||
| dropmissingsubj = false, | ||
| dropincompletesubj = false, | ||
| info::Bool = true, | ||
| warns::Bool = true, | ||
| autoseq::Bool = false, | ||
| logt::Bool = true)</code></pre><ul><li><code>vars</code> - variabel's column(s);</li><li><code>subject</code> - subject's column;</li><li><code>period</code> - period's column;</li><li><code>formulation</code> - formulation's column;</li><li><code>sequence</code> -sequence's column;</li><li><code>stage</code> - stage's column;</li><li><code>reference</code> - reference value for <code>formulation</code> column;</li><li><code>design</code> - design: "parallel", "2X2", "2X2X2", "2X2X4", ets. (formulations X sequences X periods);</li><li><code>seqcheck</code> - check sequencs; </li><li><code>designcheck</code> - check design correctness; </li><li><code>dropcheck</code> - dropuot check;</li><li><code>dropmissingsubj</code> - drop subjects with missing data;</li><li><code>dropincompletesubj</code> - drop subjects with no full sequence data (work only if <code>seqcheck</code> = true);</li><li><code>info</code> - show information;</li><li><code>warns</code> - show warnings;</li><li><code>autoseq</code> - try to make sequence collumn;</li><li><code>logt</code> - if <code>true</code> (default) data is already log-transformed, else <code>log()</code> will be used.</li></ul><p>If <code>dropmissingsubj</code> or <code>dropincompletesubj</code> used - copy of the data will be filtered.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/PharmCat/MetidaBioeq.jl/blob/0b6d2e7246bbab93ee0d0517a2c30d5ed05b9649/src/bioequivalence.jl#L22-L62">source</a></section></article><h3 id="MetidaBioeq.estimate"><a class="docs-heading-anchor" href="#MetidaBioeq.estimate">MetidaBioeq.estimate</a><a id="MetidaBioeq.estimate-1"></a><a class="docs-heading-anchor-permalink" href="#MetidaBioeq.estimate" title="Permalink"></a></h3><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="MetidaBioeq.estimate" href="#MetidaBioeq.estimate"><code>MetidaBioeq.estimate</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">estimate(be; estimator = "auto", method = "auto", supresswarn = false)</code></pre><p><code>method</code> - Model settings.</p><ul><li>if <code>method == "auto"</code> than method <code>A</code> used for "2X2" and "2X2X2" designes, method <code>P</code> for "parallel" design and method <code>B</code> for any other.</li></ul><p><em>Methods:</em></p><ul><li><code>A</code> using GLM and model <code>@formula(var ~ formulation + period + sequence + subject)</code></li><li><code>B</code> using MixedModels and model <code>@formula(var ~ formulation + period + sequence + (1|subject))</code> or Metida and model <code>@lmmformula(v ~ formulation + period + sequence, random = 1|subject:SI)</code></li><li><code>C</code> using Metida and model <code>@lmmformula(v ~ formulation + period + sequence, random = formulation|subject:CSH, repeated = formulation|subject:DIAG)</code></li><li><code>P</code> using GLM and model <code>@formula(var ~ formulation)</code></li></ul><p><code>estimator</code> - Estimator settings.</p><ul><li>if <code>estimator == "auto"</code> than GLM used for "parallel" design; for "2X2" design used GLM if no droputs and MixedModels if <code>dropout == true</code>; for other designes with method <code>C</code> Metida used and MixedModel for other cases.</li></ul><p><em>Estimators:</em></p><ul><li>"glm" for GLM (https://juliastats.org/GLM.jl/stable/)</li><li>"mm" for MixedModels (https://juliastats.org/MixedModels.jl/stable/)</li><li>"met" for Metida (https://pharmcat.github.io/Metida.jl/stable/)</li></ul><p><em>Other autosettings:</em></p><p>If design is "parallel" <code>estimator</code> set as "glm" and <code>method</code> as "P".</p><p>If design is "2X2" and method is "P" or "C" than if <code>estimator</code> == "glm" method set as "A" and "B" for other estimators. </p><p>If design not "parallel" or "2X2": </p><p>if method not "A", "B" or "C" than set as "A" for "glm" ann as B for other estimators;</p><p>if <code>estimator</code> == "glm" and <code>method</code> == "B" than <code>estimator</code> set as "mm", if <code>estimator</code> == "glm" or "mm" and <code>method</code> == "C" than <code>estimator</code> set as "met".</p><p>Reference:</p><p>EMA: <a href="https://www.ema.europa.eu/en/documents/scientific-guideline/guideline-investigation-bioequivalence-rev1_en.pdf">GUIDELINE ON THE INVESTIGATION OF BIOEQUIVALENCE</a></p><p>EMA: <a href="https://www.ema.europa.eu/en/documents/other/31-annex-i-statistical-analysis-methods-compatible-ema-bioequivalence-guideline_en.pdf">GUIDELINE ON THE INVESTIGATION OF BIOEQUIVALENCE, Annex I</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/PharmCat/MetidaBioeq.jl/blob/0b6d2e7246bbab93ee0d0517a2c30d5ed05b9649/src/bioequivalence.jl#L339-L384">source</a></section></article><h3 id="MetidaBioeq.result"><a class="docs-heading-anchor" href="#MetidaBioeq.result">MetidaBioeq.result</a><a id="MetidaBioeq.result-1"></a><a class="docs-heading-anchor-permalink" href="#MetidaBioeq.result" title="Permalink"></a></h3><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="MetidaBioeq.result" href="#MetidaBioeq.result"><code>MetidaBioeq.result</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">result(beres::BEResults)</code></pre><p>Returns dataframe with bioequivalence results.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/PharmCat/MetidaBioeq.jl/blob/0b6d2e7246bbab93ee0d0517a2c30d5ed05b9649/src/bioequivalence.jl#L664-L668">source</a></section></article><h3 id="MetidaBioeq.makeseq"><a class="docs-heading-anchor" href="#MetidaBioeq.makeseq">MetidaBioeq.makeseq</a><a id="MetidaBioeq.makeseq-1"></a><a class="docs-heading-anchor-permalink" href="#MetidaBioeq.makeseq" title="Permalink"></a></h3><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="MetidaBioeq.makeseq" href="#MetidaBioeq.makeseq"><code>MetidaBioeq.makeseq</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">makeseq(data; | ||
| subject = :subject, | ||
| period = :period, | ||
| formulation = :formulation)</code></pre><p>Make sequence vector from <code>data</code> and <code>subject</code>, <code>period</code>, <code>formulation</code> columns.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/PharmCat/MetidaBioeq.jl/blob/0b6d2e7246bbab93ee0d0517a2c30d5ed05b9649/src/bioequivalence.jl#L293-L300">source</a></section></article><h3 id="MetidaBase"><a class="docs-heading-anchor" href="#MetidaBase">MetidaBase</a><a id="MetidaBase-1"></a><a class="docs-heading-anchor-permalink" href="#MetidaBase" title="Permalink"></a></h3><p>See https://github.com/PharmCat/MetidaBase.jl</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../example/">« Example</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.0 on <span class="colophon-date" title="Friday 17 January 2025 01:28">Friday 17 January 2025</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.