# ------------------------------------------------
# CITATION.cff file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# ------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "tantivyr" in publications use:'
type: software
license: MIT
title: 'tantivyr: Fast Full-Text Search for R with ''Tantivy'''
version: 0.1.0
abstract: Index data frames and document collections and run fast full-text search
  entirely on your machine. 'tantivyr' wraps the 'Tantivy' 'Rust' search engine (a
  'Lucene'-inspired library) to provide 'BM25' ranking, structured filters, snippet
  highlighting and incremental updates over an on-disk or in-memory index. First-class
  support is provided for stemming and stop words in Portuguese and English, making
  it well suited to public documents, news clippings, extracted 'PDF' text, transcripts
  and legal acts.
authors:
- family-names: Leite
  given-names: Andre
  email: leite@castlab.org
- family-names: Wasilew
  given-names: Marcos
  email: marcos.wasilew@gmail.com
- family-names: Vasconcelos
  given-names: Hugo
  email: hugo.vasconcelos@ufpe.br
- family-names: Amorim
  given-names: Carlos
  email: carlos.agaf@ufpe.br
- family-names: Bezerra
  given-names: Diogo
  email: diogo.bezerra@ufpe.br
repository: https://cran.r-universe.dev
repository-code: https://github.com/StrategicProjects/tantivyr
commit: bbb358b57932abcb5696df2b4a3e6c9249e925e7
url: https://strategicprojects.github.io/tantivyr/
date-released: '2026-07-15'
contact:
- family-names: Leite
  given-names: Andre
  email: leite@castlab.org