gs_ws_resize: Resize a worksheet

Description Usage Arguments Note Examples

View source: R/gs_ws.R

Description

Set the number of rows and columns of a worksheet. We use this function internally during cell updates, if the data would exceed the current worksheet extent, and to trim worksheet down to fit the data exactly. Is it possible a user might want to use this directly?

Usage

1
2
gs_ws_resize(ss, ws = 1, row_extent = NULL, col_extent = NULL,
  verbose = TRUE)

Arguments

ss

a registered Google spreadsheet, i.e. a googlesheet object

ws

positive integer or character string specifying index or title, respectively, of the worksheet

row_extent

integer for new row extent; if unspecified, the Google Sheets default is 1000

col_extent

integer for new column extent; if unspecified, the Google Sheets default is 26

verbose

logical; do you want informative messages?

Note

Setting rows and columns to less than the current worksheet dimensions will delete contents without warning!

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 
yo <- gs_new("yo")
yo <- gs_edit_cells(yo, input = head(iris), trim = TRUE)
gs_read_csv(yo)
yo <- gs_ws_resize(yo, ws = "Sheet1", row_extent = 5, col_extent = 4)
gs_read_csv(yo)
yo <- gs_ws_resize(yo, ws = 1, row_extent = 3, col_extent = 3)
gs_read_csv(yo)
yo <- gs_ws_resize(yo, row_extent = 2, col_extent = 2)
gs_read_csv(yo)
gs_delete(yo)

## End(Not run)

jennybc/googlesheets documentation built on Feb. 8, 2022, 11:48 p.m.