Merge pull request #36 from r-world-devs/maciekbanas/15/complete-docu…

…mentation-of-functions

Add docs and roxygenize package.

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: GitAI
 Title: Extracts Knowledge From Git Repositories
-Version: 0.0.0.9002
+Version: 0.0.0.9003
 Authors@R: c(
     person("Kamil", "Wais", , "[email protected]", role = c("aut", "cre")),
     person("Maciej", "Banas", , "[email protected]", role = "aut")

NAMESPACE

@@ -1,2 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
+export(add_files)
+export(initialize_project)
+export(process_repos)
+export(set_github_repos)
+export(set_gitlab_repos)
+export(set_llm)
+export(set_prompt)

R/add_files.R

@@ -1,6 +1,9 @@
+#' Add files to `GitAI` object.
 #' @name add_files
+#' @param gitai A \code{GitAI} object.
 #' @param files A character vector of file paths. May be defined with
 #'   regular expression.
+#' @return A \code{GitAI} object.
 #' @export
 add_files <- function(gitai, files) {
   if (!is.null(files)) {

R/initialize_project.R

@@ -1,4 +1,7 @@
-#' export
+#' Initialize a `GitAI` project.
+#' @param project_id A character, ID of the project.
+#' @return A \code{GitAI} object.
+#' @export
 initialize_project <- function(project_id) {
 
   GitAI$new(project_id = project_id)

R/process_repos.R

@@ -1,8 +1,8 @@
+#' Run LLM on `GitAI` repositories content
 #' @name process_repos
-#' @param gitai A GitAI object.
-#'
+#' @param gitai A \code{GitAI} object.
+#' @return A list.
 #' @export
-
 process_repos <- function(gitai) {
 
   gitstats <- gitai$gitstats

R/set_llm.R

@@ -1,10 +1,17 @@
-#' export
-set_llm <- function(gitai, 
+#' Set Large Language Model in `GitAI` object.
+#' @name set_llm
+#' @param gitai A \code{GitAI} object.
+#' @param provider A LLM provider.
+#' @param model A LLM model.
+#' @param seed An integer to make results more reproducible.
+#' @return A \code{GitAI} object.
+#' @export
+set_llm <- function(gitai,
                     provider = "openai",
                     model = "gpt-4o-mini",
                     seed = NULL,
                     ...) {
-  
+
   if (provider == "openai") {
 
     gitai$llm <- elmer::chat_openai(
@@ -18,9 +25,14 @@ set_llm <- function(gitai,
   invisible(gitai)
 }
 
-#' export
+#' Set prompt.
+#' @name set_prompt
+#' @param gitati A \code{GitAI} object.
+#' @param system_prompt A system prompt.
+#' @return A \code{GitAI} object.
+#' @export
 set_prompt <- function(gitai, system_prompt) {
 
   gitai$system_prompt <- system_prompt
   invisible(gitai)
-}
+}

R/set_repos.R

@@ -1,7 +1,9 @@
+#' Set GitHub repositories in `GitAI` object.
 #' @name set_github_repos
-#' @param gitai A GitAI object.
+#' @param gitai A \code{GitAI} object.
 #' @param host A character, GitHub host.
 #' @param repos A character vector or repositories full names.
+#' @return A \code{GitAI} object.
 #' @export
 set_github_repos <- function(gitai,
                              host = NULL,
@@ -20,10 +22,12 @@ set_github_repos <- function(gitai,
   invisible(gitai)
 }
 
+#' Set GitLab repositories in `GitAI` object.
 #' @name set_gitlab_repos
-#' @param gitai A GitAI object.
+#' @param gitai A \code{GitAI} object.
 #' @param host A character, GitLab host.
 #' @param repos A character vector or repositories full names.
+#' @return A \code{GitAI} object.
 #' @export
 set_gitlab_repos <- function(gitai,
                              host = NULL,