diff --git a/R/gitstats_functions.R b/R/gitstats_functions.R index df00de28..31950f77 100644 --- a/R/gitstats_functions.R +++ b/R/gitstats_functions.R @@ -107,6 +107,7 @@ set_gitlab_host <- function(gitstats_object, #' result from its storage. #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and printing #' output is switched off. +#' @return A data.frame. #' @examples #' \dontrun{ #' my_gitstats <- create_gitstats() %>% @@ -147,7 +148,7 @@ get_repos <- function(gitstats_object, #' result from its storage. #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and #' printing output is switched off. -#' @return A `GitStats` class object with commits table. +#' @return A data.frame. #' @examples #' \dontrun{ #' my_gitstats <- create_gitstats() %>% @@ -227,7 +228,7 @@ get_commits_stats = function(gitstats_object, #' ) #' get_users(my_gitstats, c("maciekabanas", "marcinkowskak")) #' } -#' @return A `GitStats` object with table of users. +#' @return A data.frame. #' @export get_users <- function(gitstats_object, logins, @@ -263,7 +264,7 @@ get_users <- function(gitstats_object, #' ) #' get_files(my_gitstats, c("LICENSE", "DESCRIPTION")) #' } -#' @return A `GitStats` object with table of files. +#' @return A data.frame. #' @export get_files <- function(gitstats_object, file_path, @@ -289,7 +290,7 @@ get_files <- function(gitstats_object, #' result from its storage. #' @param verbose A logical, `TRUE` by default. If `FALSE` messages and #' printing output is switched off. -#' @return A table of repositories content. +#' @return A data.frame. #' @examples #' \dontrun{ #' my_gitstats <- create_gitstats() %>% @@ -320,7 +321,7 @@ get_R_package_usage <- function( #' @name get_release_logs #' @description Pull release logs from repositories. #' @inheritParams get_commits -#' @return A table with release logs. +#' @return A data.frame. #' @examples #' \dontrun{ #' my_gitstats <- create_gitstats() %>% diff --git a/man/get_R_package_usage.Rd b/man/get_R_package_usage.Rd index 92b95055..4f794e07 100644 --- a/man/get_R_package_usage.Rd +++ b/man/get_R_package_usage.Rd @@ -27,7 +27,7 @@ result from its storage.} printing output is switched off.} } \value{ -A table of repositories content. +A data.frame. } \description{ Wrapper over searching repositories by code blobs related to diff --git a/man/get_commits.Rd b/man/get_commits.Rd index 1720df4a..7a402613 100644 --- a/man/get_commits.Rd +++ b/man/get_commits.Rd @@ -26,7 +26,7 @@ result from its storage.} printing output is switched off.} } \value{ -A \code{GitStats} class object with commits table. +A data.frame. } \description{ List all commits from all repositories for an organization or a diff --git a/man/get_files.Rd b/man/get_files.Rd index 07d0216f..caf57174 100644 --- a/man/get_files.Rd +++ b/man/get_files.Rd @@ -24,7 +24,7 @@ result from its storage.} printing output is switched off.} } \value{ -A \code{GitStats} object with table of files. +A data.frame. } \description{ Pull files content from Git Hosts. diff --git a/man/get_release_logs.Rd b/man/get_release_logs.Rd index e6ba9f86..ef945bc4 100644 --- a/man/get_release_logs.Rd +++ b/man/get_release_logs.Rd @@ -26,7 +26,7 @@ result from its storage.} printing output is switched off.} } \value{ -A table with release logs. +A data.frame. } \description{ Pull release logs from repositories. diff --git a/man/get_repos.Rd b/man/get_repos.Rd index a7a9e740..f18c34a2 100644 --- a/man/get_repos.Rd +++ b/man/get_repos.Rd @@ -35,6 +35,9 @@ result from its storage.} \item{verbose}{A logical, \code{TRUE} by default. If \code{FALSE} messages and printing output is switched off.} } +\value{ +A data.frame. +} \description{ List all repositories for an organization or by a keyword. } diff --git a/man/get_users.Rd b/man/get_users.Rd index 94318d8f..c77ca201 100644 --- a/man/get_users.Rd +++ b/man/get_users.Rd @@ -23,7 +23,7 @@ result from its storage.} printing output is switched off.} } \value{ -A \code{GitStats} object with table of users. +A data.frame. } \description{ Pull users data from Git Host.