Learn R Programming

smartsheetr

smartsheetr is an extensible smartsheet API client. It utilizes the API to push/pull data frames as smartsheet documents.

Installation

You can install the released version of smartsheetr from CRAN with:

install.packages("smartsheetr")

You can install the development version of smartsheetr from GitHub with:

# install.packages("devtools")
devtools::install_github("cole-johanson/smartsheetr")

You will also need to generate a smartsheet API key and then add it as a global environment variable:

Sys.setenv("SMARTSHEET_API_TOKEN" = <your token>)

Example

Upload a sample data frame, and read it back into R:

ss_mtcars_resp = smartsheetr::ss_write_sheet("mtcars", mtcars)
ss_mtcars_sheetid = smartsheetr::ss_sheetid(ss_mtcars_resp)
smartsheetr::ss_list_sheets() |> dplyr::filter(name == 'mtcars')
#>                 id   name accessLevel
#> 1 4018535999164292 mtcars       OWNER
#>                                                                    permalink
#> 1 https://app.smartsheet.com/sheets/47v6g7p3hGCg9CV4gQRJrF3fmPGwxjhQJ8r92rP1
#>              createdAt           modifiedAt
#> 1 2023-10-25T21:39:59Z 2023-10-25T21:39:59Z
smartsheetr::ss_read_sheet(ss_mtcars_sheetid)
#> # A tibble: 32 × 11
#>      mpg   cyl  disp    hp  drat    wt  qsec    vs    am  gear  carb
#>    <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl>
#>  1  21       6  160    110  3.9   2.62  16.5     0     1     4     4
#>  2  21       6  160    110  3.9   2.88  17.0     0     1     4     4
#>  3  22.8     4  108     93  3.85  2.32  18.6     1     1     4     1
#>  4  21.4     6  258    110  3.08  3.22  19.4     1     0     3     1
#>  5  18.7     8  360    175  3.15  3.44  17.0     0     0     3     2
#>  6  18.1     6  225    105  2.76  3.46  20.2     1     0     3     1
#>  7  14.3     8  360    245  3.21  3.57  15.8     0     0     3     4
#>  8  24.4     4  147.    62  3.69  3.19  20       1     0     4     2
#>  9  22.8     4  141.    95  3.92  3.15  22.9     1     0     4     2
#> 10  19.2     6  168.   123  3.92  3.44  18.3     1     0     4     4
#> # ℹ 22 more rows

Copy Link

Version

Install

install.packages('smartsheetr')

Monthly Downloads

338

Version

0.1.0

License

MIT + file LICENSE

Maintainer

Cole Johanson

Last Published

October 28th, 2023

Functions in smartsheetr (0.1.0)

ss_delete_rows

Delete rows from a given sheet
unlist_and_replace_null

Helper function to replace NULL values with NA, and unlist, which is useful in converting nested lists to data frames
ss_delete_sheet

Delete a smartsheet
to_json

Convert list to a JSON character vector
ss_write_sheet_columns

Write the initial columns for the a sheet
ss_sheet_share

Share a sheet with a user
validate_ss_id

Validate or get the sheetID from a numeric/character vector
ss_write_sheet

Create a sheet
ss_sheetid

Get a smartsheet sheetId from a response
ss_column_ids

List column ids for a given sheet
ss_api

The workhorse function that performs each call to the Smartsheet API
smartsheetr-package

smartsheetr: Access and Write 'Smartsheet' Data using the 'Smartsheet' API 2.0
ss_column_type_to_class

Return an empty vector of the correct class from the smartsheet Column Type
ss_cols_to_dataframe

Helper function to take columns data and create a data frame.
ss_column_type

Return the Smartsheet Column Type that aligns with the R class
ss_add_columns

Add columns to an existing sheet
random_sheet_name

Get a random sheet name
ss_delete_columns

Delete non-primary columns from a given sheet.
ss_resp_data_to_dataframe

Helper to rbind lists in a list into a data frame
ss_add_rows

Add rows to a sheet.
ss_list_sheets

Get a data frame describing the smartsheets available
ss_replace_sheet

Replace the contents of a sheet with a new data frame
ss_read_sheet

Reads a Smartsheet sheet into an R data frame
ss_rename_columns

Rename columns
ss_list_sheet_shares

List share data for a given sheet
ss_get

Execute curl commands for the Smartsheet API
ss_list_users

List smartsheet users
ss_row_ids

List row ids for a given sheet