gs_ws_rename: Rename a worksheet within a spreadsheet

Description Usage Arguments Value Note Examples

Description

Give a worksheet a new title that does not duplicate the title of any existing worksheet within the spreadsheet.

Usage

1
gs_ws_rename(ss, from = 1, to, verbose = TRUE)

Arguments

ss

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

from

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

to

character string for new title of worksheet

verbose

logical; do you want informative messages?

Value

a googlesheet object

Note

Since the edit link is used in the PUT request, the version path in the url changes everytime changes are made to the worksheet, hence consecutive function calls using the same edit link from the same sheet object without 'refreshing' it by re-registering results in a HTTP 409 Conflict.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
gap_ss <- gs_copy(gs_gap(), to = "gap_copy")
gs_ws_ls(gap_ss)
gap_ss <- gs_ws_rename(gap_ss, from = "Oceania", to = "ANZ")
gs_ws_ls(gap_ss)
gap_ss <- gs_ws_rename(gap_ss, from = 1, to = "I am the first sheet!")
gs_ws_ls(gap_ss)
gs_delete(gap_ss)

## End(Not run)

googlesheets documentation built on May 2, 2019, 1:57 p.m.