<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Scatter Plot with Marginal Histograms — ggscatterhist • ggpubr</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><script src="../extra.js"></script><meta property="og:title" content="Scatter Plot with Marginal Histograms — ggscatterhist"><meta property="og:description" content="Create a scatter plot with marginal histograms, density plots or
box plots."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">ggpubr</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.6.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/kassambara/ggpubr/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Scatter Plot with Marginal Histograms</h1>
<small class="dont-index">Source: <a href="https://github.com/kassambara/ggpubr/blob/HEAD/R/ggscatterhist.R" class="external-link"><code>R/ggscatterhist.R</code></a></small>
<div class="hidden name"><code>ggscatterhist.Rd</code></div>
</div>
<div class="ref-description">
<p>Create a scatter plot with marginal histograms, density plots or
box plots.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ggscatterhist</span><span class="op">(</span></span>
<span> <span class="va">data</span>,</span>
<span> <span class="va">x</span>,</span>
<span> <span class="va">y</span>,</span>
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> color <span class="op">=</span> <span class="st">"black"</span>,</span>
<span> fill <span class="op">=</span> <span class="cn">NA</span>,</span>
<span> palette <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> shape <span class="op">=</span> <span class="fl">19</span>,</span>
<span> size <span class="op">=</span> <span class="fl">2</span>,</span>
<span> linetype <span class="op">=</span> <span class="st">"solid"</span>,</span>
<span> bins <span class="op">=</span> <span class="fl">30</span>,</span>
<span> margin.plot <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"density"</span>, <span class="st">"histogram"</span>, <span class="st">"boxplot"</span><span class="op">)</span>,</span>
<span> margin.params <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span> margin.ggtheme <span class="op">=</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggtheme.html" class="external-link">theme_void</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span> margin.space <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> main.plot.size <span class="op">=</span> <span class="fl">2</span>,</span>
<span> margin.plot.size <span class="op">=</span> <span class="fl">1</span>,</span>
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> xlab <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> ylab <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> legend <span class="op">=</span> <span class="st">"top"</span>,</span>
<span> ggtheme <span class="op">=</span> <span class="fu"><a href="theme_pubr.html">theme_pubr</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span> print <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for ggscatterhist</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span></span>
<span> <span class="va">x</span>,</span>
<span> margin.space <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> main.plot.size <span class="op">=</span> <span class="fl">2</span>,</span>
<span> margin.plot.size <span class="op">=</span> <span class="fl">1</span>,</span>
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> legend <span class="op">=</span> <span class="st">"top"</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>data</dt>
<dd><p>a data frame</p></dd>
<dt>x</dt>
<dd><p>an object of class <code>ggscatterhist</code>.</p></dd>
<dt>y</dt>
<dd><p>y variables for drawing.</p></dd>
<dt>group</dt>
<dd><p>a grouping variable. Change points color and shape by groups if
the options <code>color</code> and <code>shape</code> are missing. Should be also
specified when you want to create a marginal box plot that is grouped.</p></dd>
<dt>color, fill</dt>
<dd><p>point colors.</p></dd>
<dt>palette</dt>
<dd><p>the color palette to be used for coloring or filling by groups.
Allowed values include "grey" for grey color palettes; brewer palettes e.g.
"RdBu", "Blues", ...; or custom color palette e.g. c("blue", "red"); and
scientific journal palettes from ggsci R package, e.g.: "npg", "aaas",
"lancet", "jco", "ucscgb", "uchicago", "simpsons" and "rickandmorty".</p></dd>
<dt>shape</dt>
<dd><p>point shape. See <code><a href="show_point_shapes.html">show_point_shapes</a></code>.</p></dd>
<dt>size</dt>
<dd><p>Numeric value (e.g.: size = 1). change the size of points and
outlines.</p></dd>
<dt>linetype</dt>
<dd><p>line type ("solid", "dashed", ...)</p></dd>
<dt>bins</dt>
<dd><p>Number of histogram bins. Defaults to 30. Pick a better value that
fit to your data.</p></dd>
<dt>margin.plot</dt>
<dd><p>the type of the marginal plot. Default is "hist".</p></dd>
<dt>margin.params</dt>
<dd><p>parameters to be applied to the marginal plots.</p></dd>
<dt>margin.ggtheme</dt>
<dd><p>the theme of the marginal plot. Default is
<code><a href="https://ggplot2.tidyverse.org/reference/ggtheme.html" class="external-link">theme_void()</a></code>.</p></dd>
<dt>margin.space</dt>
<dd><p>logical value. If TRUE, adds space between the main plot
and the marginal plot.</p></dd>
<dt>main.plot.size</dt>
<dd><p>the width of the main plot. Default is 2.</p></dd>
<dt>margin.plot.size</dt>
<dd><p>the width of the marginal plot. Default is 1.</p></dd>
<dt>title</dt>
<dd><p>plot main title.</p></dd>
<dt>xlab</dt>
<dd><p>character vector specifying x axis labels. Use xlab = FALSE to
hide xlab.</p></dd>
<dt>ylab</dt>
<dd><p>character vector specifying y axis labels. Use ylab = FALSE to
hide ylab.</p></dd>
<dt>legend</dt>
<dd><p>specify the legend position. Allowed values include: "top",
"bottom", "left", "right".</p></dd>
<dt>ggtheme</dt>
<dd><p>the theme to be used for the scatter plot. Default is
<code><a href="theme_pubr.html">theme_pubr</a>()</code>.</p></dd>
<dt>print</dt>
<dd><p>logical value. If <code>TRUE</code> (default), print the plot.</p></dd>
<dt>...</dt>
<dd><p>other arguments passed to the function <code><a href="ggscatter.html">ggscatter</a>()</code>.</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>an object of class <code>ggscatterhist</code>, which is list of ggplots,
including the following elements:</p><ul><li><p>xplot: marginal x-axis plot;</p></li>
<li><p>yplot: marginal y-axis plot.</p></li>
</ul><p>.</p>
<p>User can modify each of plot before printing.</p>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Basic scatter plot with marginal density plot</span></span></span>
<span class="r-in"><span><span class="fu">ggscatterhist</span><span class="op">(</span><span class="va">iris</span>, x <span class="op">=</span> <span class="st">"Sepal.Length"</span>, y <span class="op">=</span> <span class="st">"Sepal.Width"</span>,</span></span>
<span class="r-in"><span> color <span class="op">=</span> <span class="st">"#00AFBB"</span>,</span></span>
<span class="r-in"><span> margin.params <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>fill <span class="op">=</span> <span class="st">"lightgray"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="ggscatterhist-1.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Grouped data</span></span></span>
<span class="r-in"><span><span class="fu">ggscatterhist</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="va">iris</span>, x <span class="op">=</span> <span class="st">"Sepal.Length"</span>, y <span class="op">=</span> <span class="st">"Sepal.Width"</span>,</span></span>
<span class="r-in"><span> color <span class="op">=</span> <span class="st">"Species"</span>, size <span class="op">=</span> <span class="fl">3</span>, alpha <span class="op">=</span> <span class="fl">0.6</span>,</span></span>
<span class="r-in"><span> palette <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"#00AFBB"</span>, <span class="st">"#E7B800"</span>, <span class="st">"#FC4E07"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> margin.params <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>fill <span class="op">=</span> <span class="st">"Species"</span>, color <span class="op">=</span> <span class="st">"black"</span>, size <span class="op">=</span> <span class="fl">0.2</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="ggscatterhist-2.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Use boxplot as marginal</span></span></span>
<span class="r-in"><span><span class="fu">ggscatterhist</span><span class="op">(</span></span></span>
<span class="r-in"><span> <span class="va">iris</span>, x <span class="op">=</span> <span class="st">"Sepal.Length"</span>, y <span class="op">=</span> <span class="st">"Sepal.Width"</span>,</span></span>
<span class="r-in"><span> color <span class="op">=</span> <span class="st">"Species"</span>, size <span class="op">=</span> <span class="fl">3</span>, alpha <span class="op">=</span> <span class="fl">0.6</span>,</span></span>
<span class="r-in"><span> palette <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"#00AFBB"</span>, <span class="st">"#E7B800"</span>, <span class="st">"#FC4E07"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span> margin.plot <span class="op">=</span> <span class="st">"boxplot"</span>,</span></span>
<span class="r-in"><span> ggtheme <span class="op">=</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggtheme.html" class="external-link">theme_bw</a></span><span class="op">(</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="ggscatterhist-3.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="co"># Add vertical and horizontal line to a ggscatterhist</span></span></span>
<span class="r-in"><span><span class="va">plots</span> <span class="op"><-</span> <span class="fu">ggscatterhist</span><span class="op">(</span><span class="va">iris</span>, x <span class="op">=</span> <span class="st">"Sepal.Length"</span>, y <span class="op">=</span> <span class="st">"Sepal.Width"</span>, print <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">plots</span><span class="op">$</span><span class="va">sp</span> <span class="op"><-</span> <span class="va">plots</span><span class="op">$</span><span class="va">sp</span> <span class="op">+</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_abline.html" class="external-link">geom_hline</a></span><span class="op">(</span>yintercept <span class="op">=</span> <span class="fl">3</span>, linetype <span class="op">=</span> <span class="st">"dashed"</span>, color <span class="op">=</span> <span class="st">"blue"</span><span class="op">)</span> <span class="op">+</span></span></span>
<span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_abline.html" class="external-link">geom_vline</a></span><span class="op">(</span>xintercept <span class="op">=</span> <span class="fl">6</span>, linetype <span class="op">=</span> <span class="st">"dashed"</span>, color <span class="op">=</span> <span class="st">"red"</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">plots</span></span></span>
<span class="r-plt img"><img src="ggscatterhist-4.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Alboukadel Kassambara.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>
</body></html>