googlesheets (version 0.3.0)

gs_ws_new: Add a new worksheet within a spreadsheet

Description

Add a new worksheet to an existing spreadsheet. By default, it will [1] have 1000 rows and 26 columns, [2] contain no data, and [3] be titled "Sheet1". Use the ws_title, row_extent, col_extent, and ... arguments to give the worksheet a different title or extent or to populate it with some data. This function calls the Google Drive API to create the worksheet and edit its title or extent. If you provide data for the sheet, then this function also calls the Google Sheets API. The title of the new worksheet can not be the same as any existing worksheet in the sheet.

Usage

gs_ws_new(ss, ws_title = "Sheet1", row_extent = 1000, col_extent = 26,
  ..., verbose = TRUE)

Arguments

ss

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

ws_title

the title for the new, sole worksheet; if unspecified, the Google Sheets default is "Sheet1"

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

...

optional arguments passed along to gs_edit_cells in order to populate the new worksheet with data

verbose

logical; do you want informative messages?

Value

a googlesheet object

Details

We anticipate that if the user wants to control the extent of the new worksheet, it will be by providing input data and specifying `trim = TRUE` (see gs_edit_cells) or by specifying row_extent and col_extent directly. But not both ... although we won't stop you. In that case, note that explicit worksheet sizing occurs before data insertion. If data insertion triggers any worksheet resizing, that will override any usage of row_extent or col_extent.

Examples

# NOT RUN {
# get a copy of the Gapminder spreadsheet
gap_ss <- gs_copy(gs_gap(), to = "Gapminder_copy")
gap_ss <- gs_ws_new(gap_ss)
gap_ss <- gs_ws_delete(gap_ss, ws = "Sheet1")
gap_ss <-
  gs_ws_new(gap_ss, ws_title = "Atlantis", input = head(iris), trim = TRUE)
gap_ss
gs_delete(gap_ss)
# }
# NOT RUN {
# }