<!-- 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>facility_user_dist — facility_user_dist • maxcovr</title>

<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

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



<meta property="og:title" content="facility_user_dist — facility_user_dist" />

<meta property="og:description" content="Uses haversines formula to calculate the distance between lat/long
co-ordinates of every facility and every user, returning a data_frame. You
can think of &quot;facilities&quot; as something like mobile towers, police centres,
or AED locations, and &quot;users&quot; as something like individual houses, crime
locations, or heart attack locations. The motivating example for this
function was finding the distance from Automatic Electronic Defibrillators
(AEDs) to each Out of Hospital Cardiac Arrest (OHCA), where the locations
for AEDs and OHCAs are in separate dataframes. Currently
facifacility_user_dist makes the strict assumption that the facility and
user dataframes have columns named aed_id, lat, and long, and ohca_id, lat,
and long. This will be updated soon." />
<meta name="twitter:card" content="summary" />



<!-- 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>
    <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">maxcovr</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.3.9200</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa 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/cross_validation_with_maxcovr.html">Using Cross Validation with maxcovr</a>
    </li>
    <li>
      <a href="../articles/intro_to_maxcovr.html">Using maxcovr</a>
    </li>
    <li>
      <a href="../articles/using_max_coverage_relocation.html">Using max_coverage_relocation</a>
    </li>
  </ul>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://github.com/njtierney/maxcovr">
    <span class="fa 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>facility_user_dist</h1>
    <small class="dont-index">Source: <a href='https://github.com/njtierney/maxcovr/blob/master/R/facility_user_dist.R'><code>R/facility_user_dist.R</code></a></small>
    <div class="hidden name"><code>facility_user_dist.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>Uses haversines formula to calculate the distance between lat/long
co-ordinates of every facility and every user, returning a data_frame. You
can think of "facilities" as something like mobile towers, police centres,
or AED locations, and "users" as something like individual houses, crime
locations, or heart attack locations. The motivating example for this
function was finding the distance from Automatic Electronic Defibrillators
(AEDs) to each Out of Hospital Cardiac Arrest (OHCA), where the locations
for AEDs and OHCAs are in separate dataframes. Currently
facifacility_user_dist makes the strict assumption that the facility and
user dataframes have columns named aed_id, lat, and long, and ohca_id, lat,
and long. This will be updated soon.</p>
    
    </div>

    <pre class="usage"><span class='fu'>facility_user_dist</span>(<span class='no'>facility</span>, <span class='no'>user</span>, <span class='kw'>coverage_distance</span> <span class='kw'>=</span> <span class='fl'>100</span>,
  <span class='kw'>nearest</span> <span class='kw'>=</span> <span class='st'>"facility"</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>facility</th>
      <td><p>a dataframe containing columns named "lat", and "long".</p></td>
    </tr>
    <tr>
      <th>user</th>
      <td><p>a dataframe containing columns "lat", and "long".</p></td>
    </tr>
    <tr>
      <th>coverage_distance</th>
      <td><p>numeric indicating the coverage level for the
facilities to be within in metres to a user. Default value is 100 metres.</p></td>
    </tr>
    <tr>
      <th>nearest</th>
      <td><p>character Can be "facility", "user", and "both". Defaults to
"facility". When set to "facility", returns a dataframe where every row is
every crime, and the closest building to each crime. When set to "user",
returns a dataframe where every row is every building, and the closest
crime to each building. set to "both", which will return every pairwise
combination of distances. Be careful whenDefault is "facility"</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>a data frame containing the two datasets joined together with columns
named facility_id, lat_facility, long_facility, user_id, lat_user,
long_user, distance in meters between each the given facility and user in a
row.</p>
    

  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      
      <li><a href="#value">Value</a></li>
          </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Nicholas Tierney.</p>
</div>

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

  

  </body>
</html>

