Do not run examples

.Rbuildignore

@@ -4,3 +4,4 @@
 ^LICENSE\.md$
 ^\.github$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

.gitignore

@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 .Rprofile
+CRAN-SUBMISSION

R/ss_add_rows.R

@@ -5,11 +5,13 @@
 #' @param column_ids A vector of the columnIds of the smartsheets sheetId. If `NULL`, this will be obtained.
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' ss_add_rows(ss_id, data.frame("PK"="1"))
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A `ss_addrows_resp` object
 #'

R/ss_column_ids.R

@@ -7,12 +7,14 @@
 #' @return A numeric vector
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' col_names = colnames(ss_read_sheet(ss_id))
 #' col_ids = ss_column_ids(ss_id)
 #' setNames(col_ids, col_names)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @export
 ss_column_ids <- function(ss_id) {

R/ss_delete_columns.R

@@ -6,13 +6,15 @@
 #' @param column_ids A vector of the smartsheet rowIds, or NULL to delete all non-primary columns
 #'
 #' @examples
+#' \dontrun{
 #' df = data.frame(PK=c(1,2), FK=c("a","b"))
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=df))
 #' col_ids = ss_column_ids(ss_id)
 #' ss_delete_columns(ss_id, col_ids[2])
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A list of ss_resp objects
 #'

R/ss_delete_rows.R

@@ -4,13 +4,15 @@
 #' @param row_ids A vector of the smartsheet rowIds, or NULL to delete all
 #'
 #' @examples
+#' \dontrun{
 #' df = data.frame(PK=c(1,2), FK=c("a","b"))
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=df))
 #' row_ids = ss_row_ids(ss_id)
 #' ss_delete_rows(ss_id, row_ids[2])
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A list of ss_resp objects
 #'

R/ss_delete_sheet.R

@@ -3,9 +3,11 @@
 #' @param ss_id The sheetId, permalink, or name of the Smartsheet sheet to read
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' ss_read_sheet(ss_id)
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A `ss_resp` object
 #'

R/ss_list_sheet_shares.R

@@ -3,10 +3,12 @@
 #' @param ss_id The sheetId, permalink, or name of the Smartsheet sheet to read
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' ss_list_sheet_shares(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A dataframe
 #'

R/ss_list_sheets.R

@@ -5,7 +5,9 @@
 #' other `smarsheetr` functions.
 #'
 #' @examples
+#' \dontrun{
 #' ss_list_sheets()
+#' }
 #'
 #' @return A dataframe
 #'

R/ss_list_users.R

@@ -1,7 +1,9 @@
 #' List smartsheet users
 #'
 #' @examples
+#' \dontrun{
 #' ss_list_users()
+#' }
 #'
 #' @return A dataframe
 #'

R/ss_read_sheet.R

@@ -3,11 +3,13 @@
 #' @param ss_id The sheetId, permalink, or name of the Smartsheet sheet to read
 #'
 #' @examples
+#' \dontrun{
 #' df = mtcars
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=df))
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A tibble::tbl_df object
 #'

R/ss_rename_columns.R

@@ -13,12 +13,14 @@
 #' @param column_locs A vector of locations of columns within the sheet to be replaced
 #'
 #' @examples
+#' \dontrun{
 #' df = data.frame("PK"=character(), "temp"=character())
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=df))
 #' ss_rename_columns(ss_id, new_names="FK", column_names="temp")
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A list of ss_resp objects
 #'

R/ss_replace_sheet.R

@@ -4,11 +4,13 @@
 #' @param data A data frame
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' ss_replace_sheet(ss_id, data=mtcars)
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A named list of ss_resp objects
 #'

R/ss_row_ids.R

@@ -5,11 +5,13 @@
 #' @param ss_id The sheetId, permalink, or name of the Smartsheet sheet to read
 #'
 #' @examples
+#' \dontrun{
 #' df = data.frame(PK=c(1,2), FK=c("a","b"))
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=df))
 #' ss_row_ids(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A numeric vector
 #'

R/ss_sheet_share.R

@@ -5,12 +5,14 @@
 #' @param access_level A character object. See \url{https://smartsheet.redoc.ly/#section/Security/Access-Levels}
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
 #' users = ss_list_users()
 #' user = users[1,'email']
 #' ss_sheet_share(ss_id, user)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return An ss_resp object
 #'

R/ss_sheetid.R

@@ -3,7 +3,9 @@
 #' @param resp An ss_resp object
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name())))
+#' }
 #'
 #' @return A numeric sheetId
 #'

R/ss_write_sheet.R

@@ -15,10 +15,12 @@
 #' @param use_rownames Logical; whether to use the rownames as the Primary Column
 #'
 #' @examples
+#' \dontrun{
 #' ss_id = ss_sheetid(ss_write_sheet(paste0("smartsheetr-example-",random_sheet_name()), data=mtcars))
 #' ss_read_sheet(ss_id)
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A smartsheetr response object
 #'
@@ -75,11 +77,13 @@ ss_write_sheet <- function(sheet_name, data = data.frame("PK" = character()), us
 #' @param data A data frame of columns to be added
 #'
 #' @examples
+#' \dontrun{
 #' temp_sheet_name = paste0("smartsheetr-example-",random_sheet_name())
 #' ss_id = ss_sheetid(ss_write_sheet_columns(temp_sheet_name, data=mtcars))
 #' ss_read_sheet(ss_id) # No rows. Use ss_write_sheet() to write the full data frame
 #' # clean up
 #' ss_delete_sheet(ss_id)
+#' }
 #'
 #' @return A `ss_createsheet_resp` object
 #'