adds tests

.Rbuildignore

@@ -4,3 +4,4 @@
 ^README\.Rmd$
 ^doc$
 ^Meta$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,49 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true

DESCRIPTION

@@ -23,5 +23,9 @@ Imports:
     utils
 Suggests: 
     knitr,
-    rmarkdown
+    rmarkdown,
+    spelling,
+    testthat (>= 3.0.0)
 VignetteBuilder: knitr
+Config/testthat/edition: 3
+Language: en-US

NAMESPACE

@@ -1,12 +1,14 @@
 # Generated by roxygen2: do not edit by hand
 
 export(chat)
+export(chat_history)
 export(copy_model)
 export(create_model)
 export(delete_model)
 export(embed_text)
 export(list_models)
 export(new_chat)
+export(ping_ollama)
 export(pull_model)
 export(query)
 export(show_model)

R/chat.r

@@ -1,4 +1,4 @@
-#' Chat with a LLM through Oolama
+#' Chat with a LLM through Ollama
 #'
 #' @details `query` sends a single question to the API, without knowledge about
 #'   previous questions (only the config message is relevant). `chat` treats new
@@ -10,7 +10,7 @@
 #'   Default is "llama2". Set option(rollama_model = "modelname") to change
 #'   default for the current session. See \link{pull_model} for more details.
 #' @param screen Logical. Should the answer be printed to the screen.
-#' @param server URL to an Oolama server (not the API). Defaults to
+#' @param server URL to an Ollama server (not the API). Defaults to
 #'   "http://localhost:11434".
 #'
 #' @return an httr2 response
@@ -41,7 +41,7 @@ query <- function(q,
     msg <- q
     if (!"user" %in% msg$role && nchar(msg$content) > 0)
       cli::cli_abort(paste("If you supply a conversation object, it needs at",
-                            "least one user message. See {.help query}."))
+                           "least one user message. See {.help query}."))
   }
 
   resp <- build_req(model = model, msg = msg, server = server)
@@ -58,16 +58,15 @@ chat <- function(q,
                  server = NULL) {
 
   config <- getOption("rollama_config", default = NULL)
-  hist <- c(rbind(the$prompts, the$responses))
+  hist <- chat_history()
 
   # save prompt
   the$prompts <- c(the$prompts, q)
 
   msg <- do.call(rbind, (list(
     if (!is.null(config)) data.frame(role = "system",
                                      content = config),
-    if (length(hist) > 0) data.frame(role = c("user", "assistant"),
-                                     content = hist),
+    if (length(hist) > 0) hist,
     data.frame(role = "user", content = q)
   )))
   resp <- query(q = msg, model = model, screen = screen, server = server)
@@ -89,3 +88,16 @@ new_chat <- function() {
   the$responses <- NULL
   the$prompts <- NULL
 }
+
+
+#' Chat history
+#'
+#' @return as
+#' @export
+chat_history <- function() {
+  hist <- c(rbind(the$prompts, the$responses))
+  if (length(hist) > 0) tibble::as_tibble(
+    data.frame(role = c("user", "assistant"),
+               content = hist)
+  ) else tibble::tibble()
+}

R/models.r

@@ -81,9 +81,9 @@ show_model <- function(model = NULL, server = NULL) {
 #'
 #' @examples
 #' modelfile <- system.file("extdata", "modelfile.txt", package = "rollama")
-#' \dontrun(create_model("mario", modelfile))
+#' \dontrun{create_model("mario", modelfile)}
 #' modelfile <- "FROM llama2\nSYSTEM You are mario from Super Mario Bros."
-#' \dontrun(create_model("mario", modelfile))
+#' \dontrun{create_model("mario", modelfile)}
 create_model <- function(model, modelfile, server = NULL) {
 
   if (is.null(server)) server <- getOption("rollama_server",
@@ -142,7 +142,8 @@ copy_model <- function(model,
 
   httr2::request(server) |>
     httr2::req_url_path_append("/api/copy") |>
-    httr2::req_body_json(list(name = model)) |>
+    httr2::req_body_json(list(source = model,
+                              destination = destination)) |>
     httr2::req_error(body = function(resp) httr2::resp_body_json(resp)$error) |>
     httr2::req_perform()
 

R/utils.r

@@ -1,11 +1,44 @@
 # package environment
 the <- new.env()
 
+#' Ping server to see if Ollama is reachable
+#'
+#' @inheritParams query
+#'
+#' @return TRUE if server is running
+#' @export
+ping_ollama <- function(server = NULL, silent = FALSE) {
+
+  if (is.null(server)) server <- getOption("rollama_server",
+                                           default = "http://localhost:11434")
+  res <- try({
+    httr2::request(server) |>
+    httr2::req_perform() |>
+    httr2::resp_body_string()
+  }, silent = TRUE)
+
+  if (!methods::is(res, "try-error")) {
+    if (!silent) cli::cli_progress_message(
+      "{cli::col_green(cli::symbol$play)} {res} at {.url {server}}!"
+    )
+    invisible(TRUE)
+  } else {
+    if (!silent) {
+      cli::cli_alert_danger("Could not connect to Ollama at {.url {server}}")
+      print(res)
+    }
+    invisible(FALSE)
+  }
+
+}
+
+
 build_req <- function(model, msg, server) {
 
   if (is.null(model)) model <- getOption("rollama_model", default = "llama2")
-  if (is.null(server)) server <- getOption("rollama_server", default = "http://localhost:11434")
-  spinner <- getOption("rollama_spinner", default = interactive())
+  if (is.null(server)) server <- getOption("rollama_server",
+                                           default = "http://localhost:11434")
+  spinner <- getOption("rollama_verbose", default = interactive())
 
   req_data <- list(model = model,
                    messages = msg,
@@ -60,8 +93,9 @@ screen_answer <- function(x) {
 
 # function to display progress in streaming operations
 pgrs <- function(resp) {
-
+  if (!getOption("rollama_verbose", default = interactive())) return(TRUE)
   the$str_prgs$stream_resp <- c(the$str_prgs$stream_resp, resp)
+  x <<- the$str_prgs$stream_resp
   resp <- the$str_prgs$stream_resp
 
   status <- strsplit(rawToChar(resp), "\n")[[1]] |>
@@ -85,10 +119,14 @@ pgrs <- function(resp) {
       the$str_prgs$total <-  purrr::pluck(s, "total", .default = 0L)
       the$str_prgs$done_pct <-
         paste(round(the$str_prgs$done / the$str_prgs$total * 100, 0), "%")
-      the$str_prgs$speed <-
-        prettyunits::pretty_bytes(
-          the$str_prgs$done /
-            (as.integer(Sys.time()) - as.integer(the$str_prgs$pb_start)))
+      if (the$str_prgs$done != the$str_prgs$total) {
+        the$str_prgs$speed <-
+          prettyunits::pretty_bytes(
+            the$str_prgs$done /
+              (as.integer(Sys.time()) - as.integer(the$str_prgs$pb_start))
+          )
+      } else the$str_prgs$speed <- 1L
+
       if (!isTRUE(the$str_prgs$pb == the$str_prgs$f)) {
         cli::cli_progress_bar(
           name = the$str_prgs$f,

README.Rmd

@@ -18,6 +18,7 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/JBGruber)
+[![R-CMD-check](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of `rollama` is to wrap the Ollama API, which allows you to run different LLMs locally and create an experience similar to ChatGPT/OpenAI's API.

README.md

@@ -4,9 +4,8 @@
 # `rollama`
 
 <!-- badges: start -->
-
-[![Lifecycle:
-experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![R-CMD-check](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml)
 [![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/JBGruber)
 <!-- badges: end -->
 

inst/WORDLIST

@@ -0,0 +1,19 @@
+ChatGPT
+Embeddings
+LLM
+LLMs
+Lifecycle
+Modelfile
+Ollama
+OpenAI's
+OpenAI’s
+Reichardt
+config
+embeddings
+http
+httr
+modelfile
+modelname
+orca
+paramters
+tibble

tests/spelling.R

@@ -0,0 +1,6 @@
+if (requireNamespace("spelling", quietly = TRUE)) {
+  spelling::spell_check_test(
+    vignettes = TRUE, error = FALSE,
+    skip_on_cran = TRUE
+  )
+}