dsTidyverseClient (version 1.0.3)

ds.filter: Keep rows that match a condition

Description

DataSHIELD implentation of dplyr::filter.

Usage

ds.filter(
  df.name = NULL,
  tidy_expr = NULL,
  .by = NULL,
  .preserve = FALSE,
  newobj = NULL,
  datasources = NULL
)

Value

No return value, called for its side effects. An object (typically a data frame or tibble) with the name specified by newobj is created on the server.

Arguments

df.name

Character specifying a serverside data frame or tibble.

tidy_expr

List of expressions that return a logical value, and are defined in terms of the variables in df.name.

.by

Optionally, a selection of columns to group by for just this operation, functioning as an alternative to dplyr::group_by

.preserve

Relevant when the .data input is grouped. If .preserve = FALSE (the default), the grouping structure is recalculated based on the resulting data, otherwise the grouping is kept as is.

newobj

Character specifying name for new server-side data frame.

datasources

DataSHIELD connections object.

Examples

if (FALSE) {
ds.filter(
  df.name = "mtcars",
  tidy_expr = list(cyl == 4 & mpg > 20),
  newobj = "filtered",
  datasources = conns
)
}