Pipe operator

Description

See magrittr::%>% for details.

Usage

lhs %>% rhs

Arguments

Value

The result of calling 'rhs(lhs)'.

App Set Up

Description

This is a function that sets up the app. It's generally called by another function

Usage

app_set_up(app_name = "google")

Arguments

Use secrets to Authorize R package to access endpoints

Description

This is a function to authorize metricminer to access calendly, github or google noninteractively from passing in a keys or tokens.

Usage

auth_from_secret(
  app_name,
  token,
  access_token,
  refresh_token,
  cache = FALSE,
  in_test = FALSE
)

Arguments

Value

OAuth token saved to the environment so the package access the API data

Examples

## Not run: 

# Example for authorizing Calendly
# You go to https://calendly.com/integrations/api_webhooks to get an api key
auth_from_secret("calendly", token = "A_calendly_token_here")

# Example for GitHub
# You go to https://github.com/settings/tokens/new to get a
# Personal Access Token
auth_from_secret("github", token = "ghp_a_github_pat_here")

# Example for authorizing for Google
token <- authorize("google")
auth_from_secret(
  app_name = "google",
  access_token = token$credentials$access_token,
  refresh_token = token$credentials$refresh_token
)

## End(Not run)

Authorize R package to access endpoints

Description

This is a function to authorize the R package to access APIs interactively. To learn more about the privacy policy for metricminer [read here](https://www.metricminer.org/privacypolicy.html)

Usage

authorize(app_name = NULL, cache = FALSE, ...)

Arguments

Value

API token saved to the environment or the cache so it can be grabbed by functions

Examples

## Not run: 

authorize()

authorize("github")

authorize("google")

authorize("calendly")

## End(Not run)

Handle Calendly GET requests

Description

This is a function that handles Calendly GET requests

Usage

calendly_get(url, token = NULL, user = NULL, count = NULL, page_token = NULL)

Arguments

Value

Calendly REST API response as a list

Examples

## Not run: 

authorize("calendly")
token <- get_token(app_name = "calendly")

result_list <- calendly_get(
  url = "https://api.calendly.com/users/me",
  token = token
)

## End(Not run)

Check the testthat check log file and print out how many errors

Description

if testthat's tests have been run, this will look for the check to see if anything truly broke It will return a TRUE/FALSE for whether or not there were errors based on the check/testthat.Rout file produced.

Usage

check_check(report_warning = TRUE)

Arguments

Value

a how many errors/warnings were found

Handle Google Analytics Lists

Description

These functions are to clean metric and dimension data from Google Analytics 'get_ga_stats()' function.

Usage

clean_ga_metrics(metrics = NULL, type = NULL)

Arguments

Value

a data frame of cleaned metrics from Google Analytics

Summarizing metrics from GitHub

Description

This is a function to get metrics for all the repositories underneath an organization

Usage

clean_repo_metrics(repo_name, repo_metric_list)

Arguments

Value

Metrics for a repository on GitHub

Default Credentials path

Description

Default Credentials path

Usage

default_creds_path(app_name)

Arguments

Delete cached metricminer credentials

Description

This is a function to delete cached creds and creds in the current environment that were set by metricminer

Usage

delete_creds(app_name = "all")

Arguments

Value

Cached credentials are deleted and report is given back

Examples

## Not run: 

delete_creds("google")

## End(Not run)

Default creds path

Description

Default creds path

Usage

encrypt_creds_path(app_name)

Arguments

Default Credentials path Get file path to an default credentials RDS

Description

Default Credentials path Get file path to an default credentials RDS

Usage

example_data_folder()

Value

Returns the file path to folder where the example data is stored

Google Form handling functions – extracting answers

Description

This is a function to get extract answers from a Google Form. It is used by the 'get_google_form()' function if dataformat = "dataframe"

Usage

extract_answers(form_info)

Arguments

Value

This returns answers from a google form

Get Calendly API user

Description

This is a function to get the Calendly API user info

Usage

get_calendly_user(token = NULL)

Arguments

Value

Calendly API user info as a list

Examples

## Not run: 

authorize("calendly")
get_calendly_user()

## End(Not run)

Get a list of papers that cite your paper

Description

This is a function to retrieve a list of papers that cite your papers

Usage

get_citation_count(paper_cite_link)

Arguments

Value

A list of the example datasets available in this package

Examples

## Not run: 

paper_cite_link <- "https://scholar.google.com/scholar?cites=6140457238337460780"

papers_cited_df <- get_citation_count(paper_cite_link)

## End(Not run)

Get config file

Description

Get the _config_automation.yml file to set up a metricminer repo

Usage

get_config_file(overwrite = FALSE)

Arguments

Value

Copies a config_automation.yml file to your current working directory

Get retrieve an example dataset

Description

This is a function to retrieve a list of the example datasets included with metricminer

Usage

get_example_data(dataset_name, envir = 1)

Arguments

Value

an object in the environment of the same example dataset name that was requested.

Examples

## Not run: 

# You can see the list of example datasets by running:
list_example_data()

# Then use the datasetes of your interest by calling it with this function
get_example_data("gform_info")

# Then if you check your global environment you will see "gform_info" included
ls()

## End(Not run)

Get metadata associated Google Analytics property

Description

This is a function to get the Google Analytics accounts that this user has access to. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_ga_metadata(property_id, token = NULL)

Arguments

Value

A list showing the metadata types available for the Google Analytics property. This can be used to craft an API request.

Examples

## Not run: 

authorize("google")
accounts <- get_ga_user()

properties_list <- get_ga_properties(account_id = accounts$id[1])

property_id <- gsub("properties/", "", properties_list$name[1])
property_metadata <- get_ga_metadata(property_id = property_id)

## End(Not run)

Get all property ids for all Google Analytics associated with an account id

Description

This retrieves all the property ids associated with a Google Analytics Account. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_ga_properties(account_id, token = NULL)

Arguments

Value

All the property ids and information about them for a Google Analytics account.

Examples

## Not run: 

authorize("google")
accounts <- get_ga_user()

properties_list <- get_ga_properties(account_id = accounts$id[1])

## End(Not run)

Get all property information for a particular property id

Description

This is a function to get the Google Analytics accounts that this user has access to. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_ga_property_info(property_id, token = NULL)

Arguments

Value

All the property ids and information about them for a Google Analytics account.

Examples

## Not run: 

authorize("google")
accounts <- get_ga_user()
properties_list <- get_ga_properties(account_id = accounts$id[1])
property_id <- gsub("properties\\/", "", properties_list$name[1])

property_info <- get_ga_property_info(property_id = property_id)

## End(Not run)

Get stats for an associated Google Analytics property

Description

This is a function to get the Google Analytics accounts that this user has access to. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_ga_stats(
  property_id,
  start_date = "2015-08-14",
  token = NULL,
  body_params = NULL,
  end_date = NULL,
  stats_type = "metrics",
  dataformat = "dataframe"
)

Arguments

Value

Metrics dimensions for a GA returned from the Google Analytics API. It can be returned as a curated data.frame or the raw version which is the API response as a list

Examples

## Not run: 

authorize("google")
accounts <- get_ga_user()

properties_list <- get_ga_properties(account_id = accounts$id[2])

property_id <- gsub("properties/", "", properties_list$name[1])
metrics <- get_ga_stats(property_id, stats_type = "metrics")
dimensions <- get_ga_stats(property_id, stats_type = "dimensions")
pages <- get_ga_stats(property_id, stats_type = "pages")

## End(Not run)

Get Google Analytics Accounts

Description

This is a function to get the Google Analytics accounts that this user has access to. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_ga_user(token = NULL, request_type = "GET")

Arguments

Value

Information about what accounts Google Analytics credentials has access to

Examples

## Not run: 

authorize("google")
get_ga_user()

## End(Not run)

Handler function for GET requests from GitHub

Description

This is a function to get the GitHub user's info

Usage

get_github(token = NULL, url)

Arguments

Value

Information regarding a Github account

Get the repository summary or time course metrics

Description

This is a function to get the information about a repository

Usage

get_github_metrics(
  repo,
  token = NULL,
  count = 1e+05,
  data_format = "dataframe",
  github_stats = "all",
  time_course = FALSE
)

Arguments

Value

Repository summary or time course metrics for a particular GitHub repository as a dataframe

Examples

## Not run: 

authorize("github")
metrics <- get_github_metrics(repo = "fhdsl/metricminer")

# If you only want some of the stats you can choose which ones with the
# github_stats argument
metrics <- get_github_metrics(
  repo = "fhdsl/metricminer",
  github_stats = c("repo_activity", "stars"))

summary_metrics <- get_github_repo_summary(repo = "fhdsl/metricminer")
timecourse_metrics <- get_github_repo_timecourse(repo = "fhdsl/metricminer")

## End(Not run)

Collect repository summary metrics

Description

This is a wrapper for get_github_metrics that has 'time_course = FALSE' so that summary metrics are collected

This is a function to get the information about a repository

Usage

get_github_repo_summary(
  repo,
  token = NULL,
  count = 1e+05,
  data_format = "dataframe",
  github_stats = "all"
)

Arguments

Value

GitHub repository summary metrics

Examples

## Not run: 

authorize("github")

summary_metrics <- get_github_repo_summary(repo = "fhdsl/metricminer")

## End(Not run)

Collect repository timecourse metrics

Description

This is a wrapper for get_github_metrics that has 'time_course = TRUE' so that timecourse metrics are collected

This is a function to get the information about a repository

Usage

get_github_repo_timecourse(
  repo,
  token = NULL,
  count = 1e+05,
  data_format = "dataframe",
  github_stats = "all"
)

Arguments

Value

GitHub repository timecourse metrics for views and clones

Examples

## Not run: 

authorize("github")

timecourse_metrics <- get_github_repo_timecourse(repo = "fhdsl/metricminer")

## End(Not run)

Get the GitHub User's info

Description

This is a function to get the GitHub user's info

Usage

get_github_user(token = NULL)

Arguments

Value

Information regarding a Github account

Examples

## Not run: 

authorize("github")
get_github_user()

## End(Not run)

Get Google Forms

Description

This is a function to get Google Form info and responses from the API. The scopes it uses are the 'See all your Google Forms forms.' and 'See all responses to your Google Forms forms.' If you don't check this box on the OAuth screen this function won't work.

Usage

get_google_form(form_id, token = NULL, dataformat = "dataframe")

Arguments

Value

This returns a list of the form info and responses to the google form. Default is to make this a list of nicely formatted dataframes.

Examples

## Not run: 

authorize("google")
form_info <- get_google_form(
  "https://docs.google.com/forms/d/1Neyj7wwNpn8wC7NzQND8kQ30cnbbETSpT0lKhX7uaQY/edit"
)
form_id <- "https://docs.google.com/forms/d/1Neyj7wwNpn8wC7NzQND8kQ30cnbbETSpT0lKhX7uaQY/edit"

### OR You can give it a direct form id

form_info <- get_google_form("1Neyj7wwNpn8wC7NzQND8kQ30cnbbETSpT0lKhX7uaQY")

## End(Not run)

Get multiple Google forms

Description

This is a wrapper function for returning google form info and responses for multiple forms at once. The scopes it uses are the 'See all your Google Forms forms.' and 'See all responses to your Google Forms forms.' If you don't check this box on the OAuth screen this function won't work.

Usage

get_multiple_forms(form_ids = NULL, token = NULL, dataformat = "dataframe")

Arguments

Value

This returns a list of API information for google forms

Examples

## Not run: 

authorize("google")
form_list <- googledrive::drive_find(
  shared_drive = googledrive::as_id("0AJb5Zemj0AAkUk9PVA"),
  type = "form"
)

multiple_forms <- get_multiple_forms(form_ids = form_list$id)

## End(Not run)

Get all metrics for all properties associated with an account

Description

This is a function to gets metrics and dimensions for all properties associated with an account. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

get_multiple_ga_metrics(
  account_id = NULL,
  property_ids = NULL,
  token = NULL,
  start_date = "2015-08-14",
  end_date = NULL,
  dataformat = "dataframe",
  stats_type = c("metrics", "dimensions", "link_clicks")
)

Arguments

Value

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

A list of metrics, dimensions, and link clicks for a for all properties underneath a Google Analytics account. It can be returned as a curated data.frame or the raw version which is the API response as a list

Examples

## Not run: 

authorize("google")
accounts <- get_ga_user()

properties_list <- get_ga_properties(account_id = accounts$id[1])
property_ids <- gsub("properties/", "", properties_list$name[1:2])

all_properties <- get_multiple_ga_metrics(account_id = accounts$id[1])

some_properties <- get_multiple_ga_metrics(property_ids = property_ids)


## End(Not run)

Retrieve metrics for a list of repos

Description

This is a function to get metrics for a list of repos. You can provide an owner and attempt retrieve all repositories from a particular organization, or you can provide a character vector of repositories.

Usage

get_multiple_repos_metrics(
  repo_names = NULL,
  token = NULL,
  data_format = "dataframe",
  time_course = FALSE,
  github_stats = "all"
)

Arguments

Value

A list of metrics for a list of repos in a dataframe format

Examples

## Not run: 

authorize("github")

repo_names <- c("fhdsl/metricminer", "jhudsl/OTTR_Template")
some_repos_metrics <- get_multiple_repos_metrics(repo_names = repo_names)

stars_and_forks <- get_multiple_repos_metrics(repo_names = repo_names,
github_stats = c("stars", "forks"))

some_repos_metrics <- get_multiple_repos_metrics(repo_names = repo_names,
 time_course = TRUE)

## End(Not run)

Retrieve list of repositories for an organization

Description

This is a function to get the information about a repository

Usage

get_org_repo_list(
  owner,
  count = 1e+05,
  data_format = "dataframe",
  token = NULL
)

Arguments

Value

a list of repositories that an organization has

Examples

## Not run: 

authorize("github")
get_org_repo_list(owner = "fhdsl")

## End(Not run)

Google Form handling functions

Description

This is a function to get metadata about a Google Form. It is used by the 'get_google_form()' function if dataformat = "dataframe".

Usage

get_question_metadata(form_info)

Arguments

Value

This returns metadata from a google form

Get Slido Files

Description

This is a function to get slido response output files. The slido files must be saved as googlesheets and cannot be xlsx. The scope it uses is the 'See, edit, create, and delete all your Google Sheets spreadsheets.' If you don't check this box on the OAuth screen this function won't work.

Usage

get_slido_files(
  drive_id,
  token = NULL,
  recursive = TRUE,
  keep_duplicates = FALSE
)

Arguments

Value

A list of the slido files and their content in a Googledrive location.

Examples

## Not run: 

drive_id <- "https://drive.google.com/drive/folders/0AJb5Zemj0AAkUk9PVA"
drive_id <- "https://drive.google.com/drive/u/0/folders/1XWXHHyj32Uw_UyaUJrqp6S--hHnM0-7l"
slido_data <- get_slido_files(drive_id)

## End(Not run)

Get timestamp repository metrics

Description

Get timestamp repository metrics

Usage

get_timestamp_repo_metrics(results, column)

Arguments

Value

Extracted timestamp metrics from the API response

Retrieve list of repositories for an organization

Description

This is a function to get the information about a repository

Usage

get_user_repo_list(
  owner,
  count = 1e+05,
  data_format = "dataframe",
  token = NULL
)

Arguments

Value

a list of repositories that an organization has

Examples

## Not run: 

authorize("github")
get_user_repo_list(owner = "metricminer")

## End(Not run)

Get Youtube channel stats

Description

This is a function to retrieve statistics for a Youtube channel

Usage

get_youtube_channel_stats(channel_id, token = NULL, dataformat = "dataframe")

Arguments

Value

A data frame of the channel stats from a Youtube channel.

Examples

## Not run: 

authorize("google")
youtube_channel_stats <- get_youtube_channel_stats("UCr73I9ZEPbn-3_1CBM57QgQ")

## End(Not run)

Get Youtube video stats

Description

This is a function to get a statistics on a Youtube video

Usage

get_youtube_video_stats(video_id, token = NULL, dataformat = "dataframe")

Arguments

Value

A data frame of the Youtube video stats.

Examples

## Not run: 

authorize("google")
youtube_video_stats <- get_youtube_video_stats("YkYnni-WuaQ")

## End(Not run)

Wrapper function for gh repository calls

Description

This is a function that wraps up gh calls for us

Usage

gh_repo_wrapper(api_call, owner, repo, token = NULL, count = 1e+05)

Arguments

Value

Metrics for a repository on GitHub

Get file path to an key encryption RDS

Description

Get file path to an key encryption RDS

Usage

key_encrypt_creds_path()

Get Calendly Event Lists

Description

This is a function to get a list of scheduled events from a Calendly user.

Usage

list_calendly_events(token = NULL, user, count = 100)

Arguments

Value

Calendly REST API response as a list

Examples

## Not run: 

authorize("calendly")
user <- get_calendly_user()
list_calendly_events(user = user$resource$uri)

## End(Not run)

Get list of example datasets

Description

This is a function to retrieve a list of the example datasets included with metricminer

Usage

list_example_data()

Value

A list of the example datasets available in this package

Examples

## Not run: 

list_example_data()

# Now you could use any of these example datasets that are printed out

get_example_data("calendly_events")

## End(Not run)

Handler for API requests from Google Analytics

Description

This is a function that handles requests from Google Analytics. The scope it uses is the ‘See and download your Google Analytics data' If you don’t this check this box on the OAuth screen this won't work.

Usage

request_ga(token, url, query = NULL, body_params = NULL, request_type)

Arguments

Value

An API response in the form of a list

Get Google Forms

Description

This is a function to get the Google Forms API requests. The scopes it uses are the 'See all your Google Forms forms.' and 'See all responses to your Google Forms forms.' If you don't check this box on the OAuth screen this function won't work.

Usage

request_google_forms(
  token,
  url,
  body_params = NULL,
  query_params = NULL,
  return_request = TRUE
)

Arguments

Value

This function returns a list from a API response JSON file

Setups folder structure for metricminer

Description

This is a function to setup a folder structure for metricminer data to be saved to. It depends on and reads Scope used for this function is the 'See, edit, create, and delete only the specific Google Drive files you use with this app.'

Usage

setup_folders(
  config_file = file.path(rprojroot::find_root(rprojroot::has_dir(".git")),
    "_config_automation.yml"),
  token = NULL
)

Arguments

Value

The googlesheet URL where the data has been written

Examples

## Not run: 

authorize("google")

setup_folders(
  config_file =  "_config_automation.yml"
)

## End(Not run)

Supported endpoints

Description

This is function stores endpoints and supported app names

Usage

supported_endpoints()

Write playlist details from YouTube

Description

Write playlist details from YouTube

Usage

write_playlist_details(playlist_id, token = NULL, outfile = NULL)

Arguments

Value

writes a file containing the dataframe of cleaned results

Examples

## Not run: 
# Not run
write_playlist_details(
  playlist_id = shorts_playlist_id,
  outfile = "youtube_shorts_data.tsv"
)
write_playlist_details(
  playlist_id = "PL6aYJ_0zJ4uCABkMngSYjPo_3c-nUUmio",
  outfile = "youtube_shorts_data.tsv"
)

## End(Not run)

Writes data to a Googlesheet

Description

This is a function to write metricminer data to a Googlesheet. Scope used for this function is the 'See, edit, create, and delete only the specific Google Drive files you use with this app.' When you get to the OAuth consent screen. If you do not check this box, this function won't work.

Usage

write_to_gsheet(
  input,
  token = NULL,
  gsheet = NULL,
  overwrite = FALSE,
  append_rows = FALSE,
  sheet = 1,
  new_sheet = FALSE,
  ...
)

Arguments

Value

The googlesheet URL where the data has been written

Examples

## Not run: 

authorize("github")
repo_list <- get_user_repo_list(owner = "metricminer")
gsheet <- paste0(
  "https://docs.google.com/spreadsheets/d/",
  "166MV4_1pfATB3Hes2HbdZCpkMc8JTT3u3eJes6Wu7Rk/edit#gid=0"
)
write_to_gsheet(repo_list)

datasheet <- write_to_gsheet(
  gsheet = gsheet,
  input = repo_list, append_rows = TRUE,
  sheet = 1
)

datasheet <- write_to_gsheet(
  gsheet = gsheet,
  input = repo_list,
  new_sheet = "github_data"
)

## End(Not run)