<!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 — ranksSecureDS4 • 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 rankssecureds4><meta property="og:description" content='Creates a data frame "sR8.df" by cbinding the data frame
"blackBox.ranks.df" with the global ranks and global quantiles vectors in
"global.ranks.quantiles.df". Performs QA on this matrix and orders the
sR8.df data frame according to the argument &amp;lt;ranks.sort.by&amp;gt; in ds.ranksSecure'><!-- 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>ranksSecureDS4.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Creates a data frame "sR8.df" by cbinding the data frame
"blackBox.ranks.df" with the global ranks and global quantiles vectors in
"global.ranks.quantiles.df". Performs QA on this matrix and orders the
sR8.df data frame according to the argument &lt;ranks.sort.by&gt; in ds.ranksSecure</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">ranksSecureDS4</span><span class="op">(</span><span class="va">ranks.sort.by</span><span class="op">)</span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>ranks.sort.by</dt>
<dd><p>a character string taking two possible values. These
are "ID.orig" and "vals.orig". These define the order in which the
output.ranks.df and summary.output.ranks.df data frames are presented. This
argument is set by the argument with the same name in ds.ranksSecure.
Default value is "ID.orig".</p></dd>

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

<p>Creates the data frame identified by the name given by the argument
(&lt;output.ranks.df&gt;) of the ds.ranksSecure function and writes it to the
serverside. If the argument &lt;output.ranks.df&gt; is NULL or unspecified the
output data frame is called "main.ranks.df". The data frame is ordered
according to the argument &lt;ranks.sort.by&gt; in ds.ranksSecure.</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>Severside assign function called by ds.ranksSecure.
Creates a data frame "sR8.df" by cbinding the data frame "blackBox.ranks.df"
with the global ranks and global quantiles vectors in
"global.ranks.quantiles.df". Checks that all components of sR8.df have the
correct dimensions and  are consistent in their ordering. If either the
number of rows or the order of the rows are inconsistent with those in
"blackBox.ranks.df" an error message is returned and the processing stops.
If sR8.df passes all QA tests it is written to the serverside as a data
frame with its name identified by the argument &lt;output.ranks.df&gt; in
ds.ranksSecure. If that argument is NULL or unspecified the data frame
is called "main.ranks.df". The ranksSecureDS4 function also orders the
combined data frame (&lt;output.ranks.df&gt;) in one of two ways: if
the argument &lt;ranks.sort.by&gt; in ds.ranksSecure is set to "ID.orig" the
combined data frame is ordered in the same way as the original V2BR vector;
if the argument &lt;ranks.sort.by&gt; is set to vals.orig" the combined data frame
is ordered by the magnitude of the values of V2BR (ascending). Having
created the data frame (&lt;output.ranks.df&gt;) in this manner it can now be
directly cbinded to either the V2BR vector itself or to a data frame, tibble
or matrix containing V2BR (assuming they are also in the order corresponding
to the argument &lt;ranks.sort.by&gt;) and this combined object can be used as the
basis of analysis based on the global ranks or quantiles including a range
of types of non-parametric analysis.</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>

