<!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>Secure ranking of "V2BR" (vector to be ranked) across all sources — ranksSecureDS3 • dsBase</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 href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/simplex/bootstrap.min.css" rel="stylesheet" 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><meta property="og:title" content="Secure ranking of " v2br to be ranked across all sources rankssecureds3><meta property="og:description" content="takes key non-disclosive components of the serverside data frame
blackbox.ranks.df over to the clientside to enable global re-ranking of the
global ranks just applying to the real data (not the pseudo-data)."><!-- 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">dsBase</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">6.3.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>
      </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Secure ranking of "V2BR" (vector to be ranked) across all sources</h1>
    
    <div class="hidden name"><code>ranksSecureDS3.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>takes key non-disclosive components of the serverside data frame
blackbox.ranks.df over to the clientside to enable global re-ranking of the
global ranks just applying to the real data (not the pseudo-data).</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">ranksSecureDS3</span><span class="op">(</span><span class="op">)</span></code></pre></div>
    </div>

    <div id="value">
    <h2>Value</h2>
    

<p>the non-disclosive elements of blackbox.output.df (see details)
on the serverside as a data frame object (called sR6.df)
on the clientside. After processing within ds.ranksSecure to create the
global ranks and global quantiles (of real data only) across all studies,
this is returned to the serverside as data frame "global.ranks.quantiles.df"
using the clientside function ds.dmtC2S. To illustrate the difference between
ranks and quantiles, if there are a total of 1000 original real observations
across all studies and one particular observation has the rank 250, it will
have quantile value 0.25 (i.e. 25<!-- %th value in the overall data ordered by --></p>


<p>increasing value). Both ranks and quantiles can have ties. For more details
about the cluster of functions that collectively enable secure global ranking
and estimation of global quantiles see the associated document entitled
"secure.global.ranking.docx". Also see the header file for ds.ranksSecure</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>Severside aggregate function called by ds.ranksSecure. The
non-disclosive components of blackbox.ranks.df that are transmitted to the
clientside are: (1) final values of the encrypted global ranks vector
after all seven rounds of encryption have been completed; (2) a set of
sequential IDs allocated to the global ranks vector in each study in their
current order based on increasing value of V2BR. This allows later re-linkage
of values back on the serverside and confirmation that that linkage is
correct. (3) a studyid vector with all values n in the nth study. This
facilitates data management on the serverside during the global ranking
of global ranks. For more details about the cluster of functions that
collectively enable secure global ranking and estimation of global quantiles
see the associated document entitled "secure.global.ranking.docx". Also see
the header file for ds.ranksSecure</p>
    </div>
    <div id="author">
    <h2>Author</h2>
    <p>Paul Burton 9th November, 2021</p>
    </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 DataSHIELD Developers.</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>

