<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <head>
  <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>Group confusion matrices — group_matrices • fairmodels</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>

<!-- dalexverse -->
<link href="../dalexverse.css" rel="stylesheet">
<link href="../dalexverse-2.css" rel="stylesheet">

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>






<meta property="og:title" content="Group confusion matrices — group_matrices" />
<meta property="og:description" content="Calculates coufusion matrices for each subgroup" />




<!-- 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]-->

<!-- google analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-5650686-14""></script>
<script>
 window.dataLayer = window.dataLayer || [];
 function gtag(){dataLayer.push(arguments);}
 gtag('js', new Date());

 gtag('config', 'UA-5650686-14');
</script>

  </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>

      <div class="navbar-brand-container">
        <a class="navbar-brand" href="../index.html">fairmodels</a>
        <div class="info">
          <span class="partof">part of the <a href="https://github.com/ModelOriented/DrWhy">DrWhy.AI</a>
           developed by the <a href="https://mi2.mini.pw.edu.pl/">MI^2 DataLab</a> </span>
          <span class="version version-default">0.1.0</span>
        </div>
      </div>
    </div>
    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="../index.html">
    <span class="fas fa fas fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="../articles/Basic_tutorial.html">Basic Tutorial</a>
    </li>
  </ul>
</li>
        
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Group confusion matrices</h1>
    
    <div class="hidden name"><code>group_metrices.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Calculates coufusion matrices for each subgroup</p>
    </div>

    <pre class="usage"><span class='fu'>group_matrices</span>(<span class='no'>data</span>, <span class='no'>group</span>, <span class='no'>outcome</span>, <span class='no'>outcome_numeric</span>, <span class='no'>cutoff</span>, <span class='kw'>probs</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>

    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>data</th>
      <td><p>data frame</p></td>
    </tr>
    <tr>
      <th>group</th>
      <td><p><code>character</code> name of column with group</p></td>
    </tr>
    <tr>
      <th>outcome</th>
      <td><p><code>character</code> name of column with outcome</p></td>
    </tr>
    <tr>
      <th>outcome_numeric</th>
      <td><p><code>numeric</code> vector of outcome</p></td>
    </tr>
    <tr>
      <th>cutoff</th>
      <td><p><code>numeric</code> cutoff for probabilities, deafult = 0.5</p></td>
    </tr>
    <tr>
      <th>probs</th>
      <td><p><code>character</code> name of column with probabilities</p></td>
    </tr>
    </table>

    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>list with values:</p><ul>
<li><p>subgroup</p><ul>
<li><p>tp - true positive values</p></li>
<li><p>fp - false positive values</p></li>
<li><p>tn - true negative values</p></li>
<li><p>fn - false negative values</p></li>
</ul></li>
</ul>


    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='fu'><a href='https://rdrr.io/r/utils/data.html'>data</a></span>(<span class='st'>"compas"</span>)

<span class='no'>glm_compas</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/stats/glm.html'>glm</a></span>(<span class='no'>Two_yr_Recidivism</span>~<span class='no'>.</span>, <span class='kw'>data</span><span class='kw'>=</span><span class='no'>compas</span>, <span class='kw'>family</span><span class='kw'>=</span><span class='fu'><a href='https://rdrr.io/r/stats/family.html'>binomial</a></span>(<span class='kw'>link</span><span class='kw'>=</span><span class='st'>"logit"</span>))
<span class='no'>y_prob</span> <span class='kw'>&lt;-</span> <span class='no'>glm_compas</span>$<span class='no'>fitted.values</span>

<span class='no'>data</span> <span class='kw'>&lt;-</span> <span class='no'>compas</span>
<span class='no'>data</span>$<span class='no'>probabilities</span> <span class='kw'>&lt;-</span> <span class='no'>y_prob</span>

<span class='no'>y_numeric</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/numeric.html'>as.numeric</a></span>(<span class='no'>compas</span>$<span class='no'>Two_yr_Recidivism</span>)-<span class='fl'>1</span>

<span class='fu'>group_matrices</span>(<span class='no'>data</span>,
               <span class='st'>"Ethnicity"</span>,
                <span class='kw'>outcome</span> <span class='kw'>=</span> <span class='st'>"Two_yr_Recidivism"</span>,
                <span class='kw'>outcome_numeric</span> <span class='kw'>=</span> <span class='no'>y_numeric</span>,
                <span class='kw'>cutoff</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>0.45</span>,<span class='fl'>6</span>),
                <span class='kw'>probs</span> <span class='kw'>=</span> <span class='st'>"probabilities"</span>)</div><div class='output co'>#&gt; $Caucasian
#&gt; $tp
#&gt; [1] 392
#&gt; 
#&gt; $fp
#&gt; [1] 282
#&gt; 
#&gt; $tn
#&gt; [1] 999
#&gt; 
#&gt; $fn
#&gt; [1] 430
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; $African_American
#&gt; $tp
#&gt; [1] 1301
#&gt; 
#&gt; $fp
#&gt; [1] 699
#&gt; 
#&gt; $tn
#&gt; [1] 815
#&gt; 
#&gt; $fn
#&gt; [1] 360
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; $Asian
#&gt; $tp
#&gt; [1] 1
#&gt; 
#&gt; $fp
#&gt; [1] 1
#&gt; 
#&gt; $tn
#&gt; [1] 22
#&gt; 
#&gt; $fn
#&gt; [1] 7
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; $Hispanic
#&gt; $tp
#&gt; [1] 88
#&gt; 
#&gt; $fp
#&gt; [1] 59
#&gt; 
#&gt; $tn
#&gt; [1] 261
#&gt; 
#&gt; $fn
#&gt; [1] 101
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; $Native_American
#&gt; $tp
#&gt; [1] 3
#&gt; 
#&gt; $fp
#&gt; [1] 1
#&gt; 
#&gt; $tn
#&gt; [1] 5
#&gt; 
#&gt; $fn
#&gt; [1] 2
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; $Other
#&gt; $tp
#&gt; [1] 52
#&gt; 
#&gt; $fp
#&gt; [1] 30
#&gt; 
#&gt; $tn
#&gt; [1] 189
#&gt; 
#&gt; $fn
#&gt; [1] 72
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "confusion_matrix"
#&gt; 
#&gt; attr(,"class")
#&gt; [1] "group_matrices"</div><div class='input'>


</div></pre>
  </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>Developed by Jakub Wiśniewski, Przemysław Biecek.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  


  </body>
</html>


