<!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>Sorting and reordering data frames, vectors or matrices — dataFrameSortDS • 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="Sorting and reordering data frames, vectors or matrices — dataFrameSortDS"><meta property="og:description" content="Sorts a data frame using a specified alphanumeric or numeric sort key"><!-- 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>Sorting and reordering data frames, vectors or matrices</h1>
    
    <div class="hidden name"><code>dataFrameSortDS.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Sorts a data frame using a specified alphanumeric or numeric sort key</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">dataFrameSortDS</span><span class="op">(</span>
  df.name <span class="op">=</span> <span class="cn">NULL</span>,
  sort.key.name <span class="op">=</span> <span class="cn">NULL</span>,
  <span class="va">sort.descending</span>,
  <span class="va">sort.method</span>
<span class="op">)</span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>df.name</dt>
<dd><p>a character string providing the name for the serverside
data.frame to be sorted. This parameter is fully specified by the equivalent
argument in ds.dataFrameShort and further details can be found at
help("ds.dataFrameSort").</p></dd>


<dt>sort.key.name</dt>
<dd><p>a character string providing the name for the sort key.
This will be a serverside vector which may sit inside the data frame to be
sorted or independently in the serverside analysis environment. But, if it
sits outside the data frame it must then be the same length as the data frame.
This parameter is fully specified by the equivalent argument
in ds.dataFrameShort and further details can be found at help("ds.dataFrameSort").</p></dd>


<dt>sort.descending</dt>
<dd><p>logical, if TRUE the data.frame will be sorted
by the sort key in descending order. Default = FALSE (sort order ascending).
This parameter is fully specified by the equivalent argument
in ds.dataFrameShort and further details can be found at help("ds.dataFrameSort").</p></dd>


<dt>sort.method</dt>
<dd><p>A character string taking one of the values: "default",
"d", "alphabetic", "a", "numeric", "n", or NULL. Default value is "default".
This parameter is fully specified by the equivalent argument
in ds.dataFrameShort and further details can be found at help("ds.dataFrameSort").</p></dd>

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

<p>the appropriately re-sorted data.frame will be written to the serverside
R environment as a data.frame named according to the &lt;newobj&gt; argument(or with
default name 'dataframesort.newobj') if no name is specified</p>
    </div>
    <div id="details">
    <h2>Details</h2>
    <p>Serverside assign function dataFrameSortDS is called by
clientside function ds.dataFrameSort.  A vector or a matrix can be
added to, or coerced into, a data frame (using function [ds.dataFrame])
and this means that they too can be sorted/reordered using ds.dataFrameSort.
Fundamentally, the function [ds.dataFrameSort] will sort a specified
data frame on the serverside using a sort key also on the serverside.
For more details see help for the clientside function: [ds.dataFrameShort]</p>
    </div>
    <div id="author">
    <h2>Author</h2>
    <p>Paul Burton, with critical error identification by
Leire Abarrategui-Martinez, for DataSHIELD Development Team, 2/4/2020</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>

