googlesheets4: range_autofit – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

range_autofit

Auto-fit columns or rows to the data

Description

Applies automatic resizing to either columns or rows of a (work)sheet. The width or height of targeted columns or rows, respectively, is determined from the current cell contents. This only affects the appearance of a sheet in the browser and doesn't affect its values or dimensions in any way.

Usage

range_autofit(ss, sheet = NULL, range = NULL, dimension = c("columns", "rows"))

Arguments

`ss`	Something that identifies a Google Sheet: its file ID, a URL from which we can recover the ID, an instance of `googlesheets4_spreadsheet` (returned by `gs4_get()`), or a `dribble`, which is how googledrive represents Drive files. Processed through `as_sheets_id()`.
`sheet`	Sheet to modify, in the sense of "worksheet" or "tab". You can identify a sheet by name, with a string, or by position, with a number. Ignored if the sheet is specified via `range`. If neither argument specifies the sheet, defaults to the first visible sheet.
`range`	Which columns or rows to resize. Optional. If you want to resize all columns or all rows, use `dimension` instead. All the usual `range` specifications are accepted, but the targeted range must specify only columns (e.g. "B:F") or only rows (e.g. "2:7").
`dimension`	Ignored if `range` is given. If consulted, `dimension` must be either `"columns"` (the default) or `"rows"`. This is the simplest way to request auto-resize for all columns or all rows.

Value

The input ss, as an instance of sheets_id

Examples

if (gs4_has_token()) {
  dat <- tibble::tibble(
    fruit = c("date", "lime", "pear", "plum")
  )

  ss <- gs4_create("range-autofit-demo", sheets = dat)
  ss

  # open in the browser
  gs4_browse(ss)

  # shrink column A to fit the short fruit names
  range_autofit(ss)
  # in the browser, notice how the column width shrank

  # send some longer fruit names
  dat2 <- tibble::tibble(
    fruit = c("cucumber", "honeydew")
  )
  ss %>% sheet_append(dat2)
  # in the browser, see that column A is now too narrow to show the data

  range_autofit(ss)
  # in the browser, see the column A reveals all the data now

  # clean up
  gs4_find("range-autofit-demo") %>%
    googledrive::drive_trash()
}

googlesheets4

Access Google Sheets using the Sheets API V4

v0.3.0

MIT + file LICENSE

Authors

Jennifer Bryan [cre, aut] (<https://orcid.org/0000-0002-6983-2759>), RStudio [cph, fnd]

Initial release