Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy committed May 14, 2024
1 parent caba602 commit c2cf8d1
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 11 deletions.
6 changes: 5 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,8 @@ resources/*
inst/extdata/docker/*
^CRAN-SUBMISSION$
^cran-comments.md$
^privacypolicy.md$
^privacypolicy.md$
CODE_OF_CONDUCT.md
LICENSE
^.config/*
^.local/*
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Suggests:
withr
Config/testthat/edition: 3
Encoding: UTF-8
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
LazyData: true
VignetteBuilder: knitr
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
export("%>%")
export(auth_from_secret)
export(authorize)
export(cache_secrets_folder)
export(calendly_get)
export(clean_ga_metrics)
export(clean_repo_metrics)
Expand Down
2 changes: 2 additions & 0 deletions R/google-analytics.R
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,8 @@ link_clicks <- function() {
#' @param account_id the account id that you'd like to retrieve stats for all properties associated with it.
#' @param property_ids A vector of property ids you'd like to retrieve metrics for.
#' @param token credentials for access to Google using OAuth. `authorize("google")`
#' @param start_date YYYY-MM-DD format of what metric you'd like to collect metrics from to start. Default is the earliest date Google Analytics were collected.
#' @param end_date YYYY-MM-DD format of what metric you'd like to collect metrics from to end. Default is today.
#' @param dataformat How would you like the data returned to you? Default is a "dataframe" but if you'd like to see the original API list result, put "raw".
#' @param stats_type Do you want to retrieve metrics or dimensions? List all you want to collect as a vector
#' @returns Either a list of dataframes where `metrics`, `dimensions` and `link clicks` are reported. But if `format` is set to "raw" then the original raw API results will be returned
Expand Down
4 changes: 1 addition & 3 deletions R/utils.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
utils::globalVariables(c(
"result", "num", "test_name", "scopes", "set_token", "browseURL", "remove_token", "get_token", "get_github", "get_calendly", "%>%",
"token", "query_params", "file_name", "accounts", "get_repo_list", "timestamp", "uniques", "req", "cache_secrets_folder", "google_folder_locations"
"token", "query_params", "file_name", "accounts", "get_repo_list", "timestamp", "uniques", "req", "cache_secrets_folder", "google_folder_locations", "google_entry"
))

#' Get list of example datasets
Expand Down Expand Up @@ -109,11 +109,9 @@ key_encrypt_creds_path <- function() {
full.names = TRUE
)
}

#' See where your cached secrets are being stored
#' @description This is a function to retrieve the file path of where your cached secrets are stored
#' @return an file path that shows where your cached secrets are stored
#' @export
#' @examples \dontrun{
#'
#' # You can see where your cached secrets are being stored by running:
Expand Down
4 changes: 3 additions & 1 deletion man/get_multiple_forms.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions man/get_multiple_ga_metrics.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions man/setup_folders.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c2cf8d1

Please sign in to comment.