Data

Tools

Indexes

Applications

Experiments

Open Source Science

rchroma

R interface to ChromaDB

https://github.com/cynkra/rchroma

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

R interface to ChromaDB

Basic Info
Statistics
  • Stars: 17
  • Watchers: 8
  • Forks: 0
  • Open Issues: 3
  • Releases: 1
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.Rmd 

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rchroma rchroma website


[![R-CMD-check](https://github.com/cynkra/rchroma/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/cynkra/rchroma/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/cynkra/rchroma/branch/main/graph/badge.svg)](https://app.codecov.io/gh/cynkra/rchroma?branch=main)


rchroma provides a clean interface to [ChromaDB](https://www.trychroma.com/), a modern vector database for storing and querying embeddings.

## Installation

You can isntall rchroma from CRAN:
```{r eval = FALSE}
install.packages("rchroma")
```

Or you can install the developer version from GitHub:

```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("cynkra/rchroma")
```


You also need a running ChromaDB instance. The easiest way to get started is using the provided Docker helper functions:

```{r eval = FALSE}
chroma_docker_run()
# use chroma_docker_stop() to stop the container
```

See the [ChromaDB documentation](https://docs.trychroma.com/docs/overview/introduction) for other installation methods.

## Usage

```{r eval = FALSE}
library(rchroma)

# Connect to ChromaDB
client <- chroma_connect()

# Create a collection and add documents with embeddings
create_collection(client, "my_collection")
add_documents(
  client,
  "my_collection",
  documents = c("apple", "banana"),
  ids = c("doc1", "doc2"),
  embeddings = list(
    c(1.0, 0.0), # apple
    c(0.8, 0.2) # banana (similar to apple)
  )
)

# Query similar documents using embeddings
query(
  client,
  "my_collection",
  query_embeddings = list(c(1.0, 0.0)), # should match apple best
  n_results = 2
)
```

Owner

  • Name: cynkra
  • Login: cynkra
  • Kind: organization
  • Email: mail@cynkra.com
  • Location: Zurich, CH

We support your business and the people behind it by helping you pick the right tools, implementing and supporting solutions, training and code review.

GitHub Events

Total
  • Create event: 7
  • Release event: 2
  • Issues event: 7
  • Watch event: 14
  • Delete event: 5
  • Issue comment event: 6
  • Public event: 1
  • Push event: 43
  • Pull request review event: 3
  • Pull request event: 12
Last Year
  • Create event: 7
  • Release event: 2
  • Issues event: 7
  • Watch event: 14
  • Delete event: 5
  • Issue comment event: 6
  • Public event: 1
  • Push event: 43
  • Pull request review event: 3
  • Pull request event: 12

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 5
  • Total pull requests: 8
  • Average time to close issues: 23 days
  • Average time to close pull requests: about 7 hours
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.38
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 8
  • Average time to close issues: 23 days
  • Average time to close pull requests: about 7 hours
  • Issue authors: 4
  • Pull request authors: 2
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.38
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • schochastics (2)
  • moodymudskipper (1)
  • wnarifin (1)
  • christophsax (1)
Pull Request Authors
  • schochastics (5)
  • christophsax (3)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 126 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: rchroma

A Client for 'ChromaDB'

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 126 Last month
Rankings
Dependent packages count: 27.2%
Dependent repos count: 33.5%
Average: 49.2%
Downloads: 86.9%
Maintainers (1)
david@schochastics.net
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • chromadb/chroma latest docker
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • chromadb/chroma latest docker
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • chromadb/chroma latest docker
DESCRIPTION cran
  • httr2 >= 1.0.0 imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests