Changes the number of rows and/or columns in a (work)sheet.
Arguments
- ss
Something that identifies a Google Sheet:
its file id as a string or
drive_id
a URL from which we can recover the id
a one-row
dribble
, which is how googledrive represents Drive filesan instance of
googlesheets4_spreadsheet
, which is whatgs4_get()
returns
Processed through
as_sheets_id()
.- sheet
Sheet to resize, in the sense of "worksheet" or "tab". You can identify a sheet by name, with a string, or by position, with a number.
- nrow, ncol
Desired number of rows or columns, respectively. The default of
NULL
means to leave unchanged.- exact
Logical, indicating whether to impose
nrow
andncol
exactly or to treat them as lower bounds. Ifexact = FALSE
,sheet_resize()
can only add cells. Ifexact = TRUE
, cells can be deleted and their contents are lost.
Value
The input ss
, as an instance of sheets_id
See also
Makes an UpdateSheetPropertiesRequest
:
<# https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#UpdateSheetPropertiesRequest>
Other worksheet functions:
sheet_add()
,
sheet_append()
,
sheet_copy()
,
sheet_delete()
,
sheet_properties()
,
sheet_relocate()
,
sheet_rename()
,
sheet_write()
Examples
if (gs4_has_token()) {
# create a Sheet with the default initial worksheet
(ss <- gs4_create("sheet-resize-demo"))
# see (work)sheet dims
sheet_properties(ss)
# no resize occurs
sheet_resize(ss, nrow = 2, ncol = 6)
# reduce sheet size
sheet_resize(ss, nrow = 5, ncol = 7, exact = TRUE)
# add rows
sheet_resize(ss, nrow = 7)
# add columns
sheet_resize(ss, ncol = 10)
# add rows and columns
sheet_resize(ss, nrow = 9, ncol = 12)
# re-inspect (work)sheet dims
sheet_properties(ss)
# clean up
gs4_find("sheet-resize-demo") %>%
googledrive::drive_trash()
}
#> ✔ Creating new Sheet: sheet-resize-demo.
#> ✔ Resizing sheet Sheet1 in sheet-resize-demo.
#> ℹ No need to change existing dims (1000 x 26).
#> ✔ Resizing sheet Sheet1 in sheet-resize-demo.
#> ✔ Changing dims: (1000 x 26) --> (5 x 7).
#> ✔ Resizing sheet Sheet1 in sheet-resize-demo.
#> ✔ Changing dims: (5 x 7) --> (7 x 7).
#> ✔ Resizing sheet Sheet1 in sheet-resize-demo.
#> ✔ Changing dims: (7 x 7) --> (7 x 10).
#> ✔ Resizing sheet Sheet1 in sheet-resize-demo.
#> ✔ Changing dims: (7 x 10) --> (9 x 12).
#> File trashed:
#> • sheet-resize-demo <id: 12Ig2li17VV-zo_ihEbMuvrEnDFLnF3RTxEKph7AqpH4>