Skip to content

Commit

Permalink
update reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Superman-jp committed Jul 16, 2024
1 parent 6862030 commit c9aa963
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 28 deletions.
Binary file modified docs/.doctrees/Multihistogram.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Raincloud_plot.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
13 changes: 3 additions & 10 deletions docs/Multihistogram.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h2>What’s this?<a class="headerlink" href="#what-s-this" title="Permalink to
<p>Macro for multihistogram using SAS GRAPH.</p>
<p>multihitogram is histogram created by each category variable and pair variable. Box width of histogram is reflect the response variable.
multihistogram is used for frequency comparison of multiple category in small display area.</p>
<p>This macro was designed based on the report of Wierenga, Madison R et al. <a class="footnote-reference brackets" href="#footcite-multiplehistogram" id="id1">1</a></p>
<p>This macro was designed based on the report of Wierenga, Madison R et al. <a class="footnote-reference brackets" href="#footcite-madison2020older" id="id1">1</a></p>
</div>
<div class="section" id="input-data">
<h2>Input data<a class="headerlink" href="#input-data" title="Permalink to this heading"></a></h2>
Expand Down Expand Up @@ -154,7 +154,6 @@ <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this heading"
<span class="n">cattitle</span><span class="o">=</span><span class="c1">#,</span>
<span class="n">leveltitle</span><span class="o">=</span><span class="c1">#,</span>
<span class="n">pairtitle</span><span class="o">=</span><span class="c1">#,</span>
<span class="n">leveltitle</span><span class="o">=</span><span class="n">level</span><span class="p">,</span>
<span class="n">responsetxt</span><span class="o">=</span><span class="n">false</span><span class="p">,</span>
<span class="n">orient</span><span class="o">=</span><span class="n">v</span><span class="p">,</span>
<span class="n">pairsplit</span><span class="o">=</span><span class="n">false</span><span class="p">,</span>
Expand Down Expand Up @@ -230,12 +229,6 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
<div><p>if True the histogram will be split by pair variable. default is “False”.</p>
</div></blockquote>
</li>
<li><p><strong>pairtitle : text (optional)</strong></p>
<blockquote>
<div><p>title of pair variable legend. if legend parameter is set “False”, this parameter will be ignored.
default is “Pair”.</p>
</div></blockquote>
</li>
<li><p><strong>legend : bool (optional)</strong></p>
<blockquote>
<div><p>if “True” the legend of pair variable is displayed.if pair parameter is “None”, this parameter will be ignored.
Expand Down Expand Up @@ -418,8 +411,8 @@ <h3>display response value<a class="headerlink" href="#display-response-value" t
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this heading"></a></h2>
<div class="docutils container" id="id2">
<dl class="footnote brackets">
<dt class="label" id="footcite-multiplehistogram"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>Running CA Wierenga MR, Crawford CR. Older us adults like sweetened colas, but not other chemesthetic beverages. 2020. URL: <a class="reference external" href="https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8140601/">https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8140601/</a>.</p>
<dt class="label" id="footcite-madison2020older"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>Madison R. Wierenga, Ciera R. Crawford, and Cordelia A. Running. Older us adults like sweetened colas, but not other chemesthetic beverages. <em>Journal of texture studies</em>, 51(5):722–732, 2020. URL: <a class="reference external" href="https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8140601/">https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8140601/</a>.</p>
</dd>
</dl>
</div>
Expand Down
16 changes: 12 additions & 4 deletions docs/Raincloud_plot.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
<li class="toctree-l3"><a class="reference internal" href="#scale-parameter">Scale parameter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#reference">Reference</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Raincloud_plot_paired.html">Raincloud plot (paired)</a></li>
Expand Down Expand Up @@ -100,13 +101,10 @@ <h1>Raincloud plot<a class="headerlink" href="#raincloud-plot" title="Permalink
<div class="section" id="what-s-this">
<h2>What’s this?<a class="headerlink" href="#what-s-this" title="Permalink to this heading"></a></h2>
<p>Macro for generate raincloud plot using SAS GRAPH.</p>
<p>Raincloud plot is contained density plot (half-violin plot) , box plot and strip plot.</p>
<p>Raincloud plot is contained density plot (half-violin plot) , box plot and strip plot. <a class="footnote-reference brackets" href="#footcite-allen2019raincloud" id="id1">1</a></p>
<p>density plot displays distribution estimated by KDE (kernel density estimation) of input data.</p>
<p>box plot displays descriptive statistics (mean, q1, q2, q3 outlier).</p>
<p>strip plot is jittered scatterplot and displays individual data.</p>
<p>more information is described in following paper.</p>
<p>Allen M, Poggiali D, Whitaker K et al. Raincloud plots: a multi-platform tool for robust data visualization
[version 2; peer review: 2 approved]. Wellcome Open Res 2021, 4:63 (<a class="reference external" href="https://doi.org/10.12688/wellcomeopenres.15191.2">https://doi.org/10.12688/wellcomeopenres.15191.2</a>)</p>
</div>
<div class="section" id="input-data">
<h2>Input data<a class="headerlink" href="#input-data" title="Permalink to this heading"></a></h2>
Expand Down Expand Up @@ -549,6 +547,16 @@ <h3>Scale parameter<a class="headerlink" href="#scale-parameter" title="Permalin
</div>
<img alt="_images/rain_width1.svg" src="_images/rain_width1.svg" /></div>
</div>
<div class="section" id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this heading"></a></h2>
<div class="docutils container" id="id2">
<dl class="footnote brackets">
<dt class="label" id="footcite-allen2019raincloud"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p>Micah Allen, Davide Poggiali, Kirstie Whitaker, Tom Rhys Marshall, Jordy van Langen, and Rogier A Kievit. Raincloud plots: a multi-platform tool for robust data visualization, version 2. <em>Wellcome open research</em>, 2021. URL: <a class="reference external" href="https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6480976/">https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6480976/</a>.</p>
</dd>
</dl>
</div>
</div>
</div>


Expand Down
7 changes: 1 addition & 6 deletions docs/_sources/Multihistogram.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Macro for multihistogram using SAS GRAPH.
multihitogram is histogram created by each category variable and pair variable. Box width of histogram is reflect the response variable.
multihistogram is used for frequency comparison of multiple category in small display area.

This macro was designed based on the report of Wierenga, Madison R et al. :footcite:p:`multiplehistogram`
This macro was designed based on the report of Wierenga, Madison R et al. :footcite:p:`madison2020older`



Expand Down Expand Up @@ -49,7 +49,6 @@ Syntax
cattitle=#,
leveltitle=#,
pairtitle=#,
leveltitle=level,
responsetxt=false,
orient=v,
pairsplit=false,
Expand Down Expand Up @@ -111,10 +110,6 @@ Parameters

if True the histogram will be split by pair variable. default is "False".

- **pairtitle : text (optional)**

title of pair variable legend. if legend parameter is set "False", this parameter will be ignored.
default is "Pair".

- **legend : bool (optional)**

Expand Down
14 changes: 7 additions & 7 deletions docs/_sources/Raincloud_plot.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,14 @@ What's this?

Macro for generate raincloud plot using SAS GRAPH.

Raincloud plot is contained density plot (half-violin plot) , box plot and strip plot.
Raincloud plot is contained density plot (half-violin plot) , box plot and strip plot. :footcite:p:`allen2019raincloud`

density plot displays distribution estimated by KDE (kernel density estimation) of input data.

box plot displays descriptive statistics (mean, q1, q2, q3 outlier).

strip plot is jittered scatterplot and displays individual data.

more information is described in following paper.

Allen M, Poggiali D, Whitaker K et al. Raincloud plots: a multi-platform tool for robust data visualization
[version 2; peer review: 2 approved]. Wellcome Open Res 2021, 4:63 (https://doi.org/10.12688/wellcomeopenres.15191.2)


*****************
Input data
Expand Down Expand Up @@ -476,4 +471,9 @@ code ::
bw_method=srot
);

.. image:: ./img/rain_width1.svg
.. image:: ./img/rain_width1.svg

***************
Reference
***************
.. footbibliography::
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@
<li class="toctree-l2"><a class="reference internal" href="Raincloud_plot.html#syntax">Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="Raincloud_plot.html#parameters">Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="Raincloud_plot.html#example">example</a></li>
<li class="toctree-l2"><a class="reference internal" href="Raincloud_plot.html#reference">Reference</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Raincloud_plot_paired.html">Raincloud plot (paired)</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit c9aa963

Please sign in to comment.