'DataSHIELD' 'Tidyverse' Server-Side Package

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 server-side package which should be installed on the server holding the data, and is used in conjunction with the client-side package 'dsTidyverseClient' which is installed in the local R environment of the analyst. For more information, see < https://tidyverse.org/> and < https://datashield.org/>.

dsTidyverse

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.

Installation

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

Functions/Features

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 vectorised conditional function.
• case_when: A general vectorised 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.

Privacy settings with dsTidyverse

Please read the separate article Privacy settings with dsTidyverse for detailed instructions on managing privacy within dsTidyverse.

Contributing

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.