Keep rows that match a condition

DataSHIELD implentation of dplyr::filter.

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

Arguments

df.name

Character specifying a serverside data frame or tibble.

expr

Expressions that return a logical value, and are defined in terms of the variables in .data

.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.

Value

An object with the name specified by the newobj argument is written serverside.

Examples

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