mutateDS

DataSHIELD implentation of <code>mutate</code>.

Implementation of selected 'Tidyverse' functions within 'DataSHIELD', an open-source federated analysis solution in R. Currently, DataSHIELD contains very limited tools for data manipulation, so the aim of this package is to improve the researcher experience by implementing essential functions for data manipulation, including subsetting, filtering, grouping, and renaming variables. This is the serverside package which should be installed on the server holding the data, and is used in conjuncture with the clientside package 'dsTidyverseClient' which is installed in the local R environment of the analyst. For more information, see <https://www.tidyverse.org/> and <https://datashield.org/>.

Tim Cadman

dsTidyverse

'DataSHIELD' 'Tidyverse' Serverside Package

Mariska Slofstra

Stuart Wheater

Demetris Avraam

mutateDS function

<dl><dt>tidy_expr</dt>
<dd>Name-value pairs. The name gives the name of the column in the output.</dd>
<dt>df.name</dt>
<dd>A data frame, data frame extension (e.g. a tibble), or a lazy data frame (e.g. from dbplyr or dtplyr).</dd>
<dt>.keep</dt>
<dd>.keep Control which columns from <code>df.name</code> are retained in the output. Grouping
columns and columns created by <code>tidy_expr</code> are always kept.<ul>
<li><code>"all"</code>: Retains all columns from <code>df.name</code>. This is the default.</li>
<li><code>"used"</code>: Retains only the columns used in <code>tidy_expr</code> to create new columns.</li>
<li><code>"unused"</code>: Retains only the columns not used in <code>tidy_expr</code> to create new columns. This is useful if you generate new columns but no longer need the columns used to generate them.</li>
<li><code>"none"</code>: Doesn't retain any extra columns from <code>df.name</code>. Only the grouping variables and columns created by <code>tidy_expr</code> are kept.</li>
</ul>Grouping columns and columns created by <code>tidy_expr</code> are always kept.</dd>
<dt>.before</dt>
<dd>&lt;tidy-select&gt; Optionally, control where new columns should appear (the default is
to add to the right hand side). See <code>relocate</code> for more details.</dd>
<dt>.after</dt>
<dd>&lt;tidy-select&gt; Optionally, control where new columns should appear (the default is
to add to the right hand side). See <code>relocate</code> for more details.</dd></dl>

Arguments

Create, modify, and delete columns — mutateDS

<dl>

<dt>tidy_expr</dt>
<dd>Name-value pairs. The name gives the name of the column in the output.</dd>


<dt>df.name</dt>
<dd>A data frame, data frame extension (e.g. a tibble), or a lazy data frame (e.g. from dbplyr or dtplyr).</dd>


<dt>.keep</dt>
<dd>.keep Control which columns from <code>df.name</code> are retained in the output. Grouping
columns and columns created by <code>tidy_expr</code> are always kept.<ul>
<li><code>"all"</code>: Retains all columns from <code>df.name</code>. This is the default.</li>
<li><code>"used"</code>: Retains only the columns used in <code>tidy_expr</code> to create new columns.</li>
<li><code>"unused"</code>: Retains only the columns not used in <code>tidy_expr</code> to create new columns. This is useful if you generate new columns but no longer need the columns used to generate them.</li>
<li><code>"none"</code>: Doesn't retain any extra columns from <code>df.name</code>. Only the grouping variables and columns created by <code>tidy_expr</code> are kept.</li>
</ul>Grouping columns and columns created by <code>tidy_expr</code> are always kept.</dd>


<dt>.before</dt>
<dd>&lt;tidy-select&gt; Optionally, control where new columns should appear (the default is
to add to the right hand side). See <code>relocate</code> for more details.</dd>


<dt>.after</dt>
<dd>&lt;tidy-select&gt; Optionally, control where new columns should appear (the default is
to add to the right hand side). See <code>relocate</code> for more details.</dd>

</dl>

mutateDS: Create, modify, and delete columns

Description

Usage

Value

Arguments