Type: Package
Title: Download Google Sheets Using Just the URL
Version: 0.4.6
Date: 2024-12-13
Description: Simple package to download Google Sheets using just the sharing link. Spreadsheets can be downloaded as a data frame, or as plain text to parse manually. Google Sheets is the new name for Google Docs Spreadsheets https://www.google.com/sheets/about.
License: GPL-3
Encoding: UTF-8
URL: https://github.com/maxconway/gsheet
BugReports: https://github.com/maxconway/gsheet/issues
Language: en-GB
Imports: httr, stringr
Suggests: testthat, readr
RoxygenNote: 7.3.2
NeedsCompilation: no
Packaged: 2024-12-13 22:03:04 UTC; max
Author: Max Conway [aut, cre]
Maintainer: Max Conway <conway.max1@gmail.com>
Repository: CRAN
Date/Publication: 2024-12-14 00:10:11 UTC

Construct a google sheet download url from the sheet's viewing url

Description

Converts the viewing url for a google sheet to a download url.

Usage

construct_download_url(url, format = "csv", sheetid = NULL)

Arguments

url

the google sheet url

format

controls the column separator used. csv or tsv

sheetid

the id of the sheet to download from. (Default NULL, downloads the first sheet)

Examples


# Download a sheet manually using readr
url <- 'docs.google.com/spreadsheets/d/1I9mJsS5QnXF2TNNntTy-HrcdHmIF9wJ8ONYvEJTXSNo'

if(requireNamespace('readr', quietly=TRUE)){
  library(readr)
  read_csv(construct_download_url(url), col_types = cols(
    mpg = col_double(),
    cyl = col_integer(),
    disp = col_double(),
    hp = col_integer(),
    drat = col_double(),
    wt = col_double(),
    qsec = col_double(),
    vs = col_integer(),
    am = col_integer(),
    gear = col_integer(),
    carb = col_integer()
  ))
}

Download Google sheet as a table

Description

This is a convenience function, designed to download a table quickly and conveniently. If you experience any unexpected results, or you want more reliability or control (e.g. for a production situation), then I'd recommend you parse manually using one of the constructions in the examples:

Usage

gsheet2tbl(url, sheetid = NULL)

Arguments

url

the google sheet url

sheetid

the index of the sheet to be downloaded. If you use the direct sheet URL, rather than the share by link, this will automatically be extracted. Otherwise, the first sheet will be downloaded by default.

Details

The Google sheet must have 'share by link' turned on.

If the package readr is available, then it will be used. This can produce slightly different, but normally better, parsings.

See Also

gsheet2text to download as plain text

Examples


# Download a sheet
url <- 'docs.google.com/spreadsheets/d/1I9mJsS5QnXF2TNNntTy-HrcdHmIF9wJ8ONYvEJTXSNo'
a <- gsheet2tbl(url)

# Download the second sheet, using the direct url
url <- 'docs.google.com/spreadsheets/d/1I9mJsS5QnXF2TNNntTy-HrcdHmIF9wJ8ONYvEJTXSNo#gid=850032961'
b <- gsheet2tbl(url)

# To download a sheet with more control, use the following:
url <- 'docs.google.com/spreadsheets/d/1I9mJsS5QnXF2TNNntTy-HrcdHmIF9wJ8ONYvEJTXSNo'
read.csv(text=gsheet2text(url, format='csv'), stringsAsFactors=FALSE)

# Or, with readr:
if(requireNamespace('readr', quietly=TRUE)){
  library(readr)
  read_csv(construct_download_url(url), col_types = cols(
    mpg = col_double(),
    cyl = col_integer(),
    disp = col_double(),
    hp = col_integer(),
    drat = col_double(),
    wt = col_double(),
    qsec = col_double(),
    vs = col_integer(),
    am = col_integer(),
    gear = col_integer(),
    carb = col_integer()
  ))
}

Download Google sheet as text.

Description

Downloads a Google sheet as text, using just the url. The Google sheet must have 'share by link' turned on.

Usage

gsheet2text(url, format = "csv", sheetid = NULL)

Arguments

url

the google sheet url

format

controls the column separator used. csv or tsv

sheetid

the id of the sheet to download from. (Default NULL, downloads the first sheet)

Details

sheetid is the index of the sheet to be downloaded. If you use the direct sheet URL, rather than the share by link, this will automatically be extracted. Otherwise, the first sheet will be downloaded by default.

See Also

gsheet2text to download as a table

Examples


url <- 'docs.google.com/spreadsheets/d/1I9mJsS5QnXF2TNNntTy-HrcdHmIF9wJ8ONYvEJTXSNo'
a <- gsheet2text(url)
b <- read.csv(text=a)