Skip to content

Commit

Permalink
docs: update about arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
eitsupi committed Nov 27, 2023
1 parent 775ce01 commit 28ee0d1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
8 changes: 6 additions & 2 deletions R/s3_methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
#' `<Series>[i]` is equivalent to `pl$select(<Series>)[i, , drop = TRUE]`.
#' @rdname S3_extract
#' @param x A [DataFrame][DataFrame_class], [LazyFrame][LazyFrame_class], or [Series][Series_class]
#' @param i Rows to select
#' @param j Columns to select, either by index or by name.
#' @param i Rows to select. Integer vector, logical vector, or an [Expression][Expr_class].
#' @param j Columns to select. Integer vector, logical vector, character vector, or an [Expression][Expr_class].
#' @param drop Convert to a Polars Series if only one column is selected.
#' @seealso
#' [`<DataFrame>$select()`][DataFrame_select],
Expand All @@ -17,10 +17,14 @@
#' df = pl$DataFrame(data.frame(a = 1:3, b = letters[1:3]))
#' lf = df$lazy()
#'
#' # Select a row
#' df[1, ]
#'
#' # If only `i` is specified, it is treated as `j`
#' # Select a column
#' df[1]
#'
#' # Select a column by name (and convert to a Series)
#' df[, "b"]
#'
#' # Can use Expression for filtering and column selection
Expand Down
8 changes: 6 additions & 2 deletions man/S3_extract.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 28ee0d1

Please sign in to comment.