dsTidyverseClient (version 1.0.3)

ds.slice: Subset rows using their positions

Description

DataSHIELD implentation of dplyr::slice.

Usage

ds.slice(
  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, provide either positive values to keep, or negative values to drop. The values provided must be either all positive or all negative. Indices beyond the number of rows in the input are silently ignored.

.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.slice(
  df.name = "mtcars",
  expr = list(1:10),
  .by = "cyl",
  newobj = "sliced_df"
)
}