README.md
In dsTidyverseClient: 'DataSHIELD' 'Tidyverse' Clientside Package

dsTidyverseClient

This is the DataSHIELD implementation of selected Tidyverse functions. Currently most of these functions are from dplyr, however in the future functions from other Tidyverse packages can be included.

Install dsTidyverse on your armadillo or opal server.
Whitelist dsTidyverse if required
Install dsTidyverseClient on your local machine

From the `dplyr` package:

select: Choose columns from a data frame.
rename: Rename columns in a data frame.
mutate: Create or modify columns.
if_else: A vectorized conditional function.
case_when: A general vectorized conditional function.
bind_cols: Combine data frames by columns.
bind_rows: Combine data frames by rows.
filter: Filter rows based on conditions.
slice: Select rows by position.
arrange: Arrange rows by values of a column or multiple columns.
group_by: Group data by one or more columns.
ungroup: Remove grouping from data.
group_keys: Retrieve the group keys from a grouped data frame.
distinct: Return unique rows based on certain columns.

From the `tibble` package:

as_tibble: Convert data to a tibble.

DataSHIELD implements privacy control levels, which allows data owners to control which functions can be used by researchers. The table below shows which dsTidyverse functions are permitted in which privacy mode.

| Function | Permissive | Banana | Avocado | Non-Permissive | |------------------|-------------|---------|---------|---------------| | arrangeDS | ✔ | ✔ | | | | asTibbleDS | ✔ | ✔ | ✔ | ✔ | | bindColsDS | ✔ | ✔ | | | | bindRowsDS | ✔ | ✔ | | | | caseWhenDS | ✔ | ✔ | | | | distinctDS | ✔ | ✔ | ✔ | ✔ | | filterDS | ✔ | ✔ | | | | groupByDS | ✔ | ✔ | | | | groupKeysDS | ✔ | ✔ | | | | mutateDS | ✔ | ✔ | | | | renameDS | ✔ | ✔ | ✔ | ✔ | | selectDS | ✔ | ✔ | ✔ | ✔ | | sliceDS | ✔ | ✔ | | | | ungroupDS | ✔ | ✔ | | |

If there are functions in this list you would like implemented, please either attempt to do so yourself and submit a pull request, or submit a feature request in the issues section. See the "CONTRIBUTING" file for more information.