Skip to contents

An R6 class to represent a Google Sheets spreadsheet. Use new_spreadsheet() or register_spreadsheet() to create instances.

Public fields

spreadsheet_id

The Google Sheets spreadsheet ID

title

The title of the spreadsheet

sheets

A tibble of sheet names and IDs

Methods


spreadsheet$new()

Create or open a spreadsheet

Usage

spreadsheet$new(id = NULL, title = "Untitled Spreadsheet", set_active = TRUE)

Arguments

id

Spreadsheet ID, URL, or NULL to create new

title

Title for new spreadsheet (only used if id is NULL)

set_active

Whether to make this the active spreadsheet

Returns

A new spreadsheet object


spreadsheet$set_active()

Set this spreadsheet as the active one

Usage

spreadsheet$set_active()

Returns

Self, invisibly


spreadsheet$set_not_active()

Remove this spreadsheet as the active one

Usage

spreadsheet$set_not_active()

Returns

Self, invisibly


spreadsheet$is_active()

Check if this is the active spreadsheet

Usage

spreadsheet$is_active()

Returns

Logical


spreadsheet$get_url()

Get the Google Sheets URL for this spreadsheet

Usage

spreadsheet$get_url()

Returns

Character URL or NULL


spreadsheet$browse()

Open the spreadsheet in a browser

Usage

spreadsheet$browse()

Returns

Self, invisibly


spreadsheet$print()

Print method for spreadsheet objects

Usage

spreadsheet$print(...)

Arguments

...

Additional arguments (unused)