R/f - GS row number.R

Defines functions f_gs_row_number

Documented in f_gs_row_number

#' @title Get number of rows in Google Sheet
#'
#' @description Get number of rows in Google Sheet.
#'
#' @author Pieter Overdevest
#'
#' @param c.gs.code Google Sheet code.
#' @param c.sheet Sheet name (default: "Sheet1")
#'
#' @returns Number of rows.
#'
#' @details -
#'
#' @export
#'
#' @examples
#' n.row <- f_gs_row_number(
#'
#'       c.gs.code = "1Gc7Z1fxLgz60xg5wGpROMyfdwubk9mqeFaMzXh6WIjU"
#'       c.sheet   = "Delta"
#' )

        #################################################################################
        # FUNCTION.
        #################################################################################

        f_gs_row_number <- function(

                c.gs.code,
                c.sheet = "Sheet1"
        ) {


        # Initialize.
        df.gs <- f_gs_url(c.gs.code, c.sheet) %>%

                gs4_get(.) %>%

                .[[6]]


        return(
                df.gs %>%

                        filter(name == c.sheet) %>%

                        pull(grid_rows)
        )

        }
pieterov/generaltoolbox documentation built on Jan. 25, 2025, 10:32 a.m.