We need to implement fuzzy matching or string distance to search for the nearest word similar to the slug if there isn't an exact match.

Right now if we run:

g <- get_glossary()
define("data frame", glossary = g)

We get:

#> Warning: Some key are not found: 'data frame'. They are being excluded.

Because it is expecting the data_frame slug and not data frame. But the define function should be able to see that this is a very near match and thus we should present this definition. I do this using cosine similarity in the Python version

Additional use case: suppose you have written a book with bookdown, and have included glossary references. You would like to include those terms (and only those terms) as a glossary in the book, so it should be possible to gather them while knitting the book (or in a separate pass).

When an R Markdown document is being compiled into HTML, we want something like the following for a glossary entry:

<a href="https://glosario.carpentries.org/en/#some_key">some term</a>

But when the same document is being compiled into LaTeX/PDF, we want:

\glossref{some term}{some\_key}

(Or something like that---the user may want some other LaTeX command for glossary references.) We cannot generate the former and hope that Pandoc will translate it into the latter. We also cannot generate LaTeX and hope that Pandoc will translate it into HTML, since Pandoc doesn't handle user-defined commands.

I have used a Lua filter to solve this problem in a book project merely-useful/py-rse#467, but we should think about how to configure the function for inserting definitions into text to handle this.

CRAN submission is harder to achieve, but I think we can publish the package to r-universe so it's accessible from another place that is not only GitHub

the project is now hosted at https://glosario.carpentries.org.

The YAML file it's not working either for Ubuntu or MacOS. I think it's a problem with the version hosted at r-lib

This repository doesn't have a CONTRIBUTING file and therefore defaults on the version found in the .github repository which applies for lessons but not for this repository. We should create one to avoid possible confusion.

1. Checking a lesson.
   1. Beatriz has made some changes to a lesson she inherited from Amari,
      and wants to check that it is still consistent.
   2. She runs a command-line script that:
      1. Reads the R Markdown file.
      2. Extracts the terms under the glossary/defines key.
      3. Searches the body of the document for calls to gdef(...).
      4. Checks that every term listed in glossary/defines is referenced in the document body,
         and that every term referenced in the document body is mentioned in glossary/defines.

By J.A.

"you could have an "as implemented in" field in the same way that you have a "see also" section. So filtering has pointers to dplyr::select() along with base::subset() and pandas.whatever."

In R/text_definition.R line 7. I'm currently doing the following:

 entries_list <- purrr::map(entries, ~.x$.__enclos_env__$private$.entries)

@zkamvar suggested in #11 that we add a public method instead of accessing the enclosed environment. This issue is to discuss and track this development.

Comment from @fmichonneau about handling links in RMd:

"We may want to provide more flexibility in the way the links are generated. For instance, we may need to provide options to switch between HTML or Markdown versions of the links. For the HTML version using the htmltools package might make it easier to provide additional attributes to the anchors."

1. Amari has written a lesson in R Markdown that includes YAML metadata
   stating that it defines correlation and causation.
2. She adds a code chunk to the end of her lesson that includes a call to
   glosario::summarize_terms().
3. When she knits the document to HTML, this code chunk inserts a definition list dl at that point. Its entries are the definitions of all of the terms listed under the glossary/defines key in the page's YAML header in alphabetical order by term according to the rules for glossary/language.

The function gdef() generates the link to the term in glosario in the page in english.
For example:

`r glosario::gdef('tidyverse', 'tidyverse')`

The link created is: https://carpentries.github.io/glosario/en/#tidyverse

Can we have an argument lang , so the function could create a link to pages in other languages?

Reference of the function:
https://carpentries.github.io/glosario-r/reference/gdef.html

Thank you!

1. Amari writes a lesson in R Markdown. She adds the glossary key to its YAML metadata and indicates that the lesson requires the term correlation and defines the term regression.
2. Beatriz is writing a lesson on linear models. She adds YAML metadata indicating that the lesson requires the term regression.
3. To find prerequisite lessons she can recommend to her students, Beatriz runs a command-line script that:
   1. Uses rmarkdown::yaml_front_matter(filename) to reads metadata from all of the lessons she has archived.
   2. Lists all of the lessons that state they define the term regression.

Use the {cli} package to improve CLI communication

Hi!
I made a page for a workshop and added some Glosario terms there. Some were still not merged, so I left them in english.
After the PR was merged, I tried to update this terms to portuguese (with lang = 'pt'), and the output was this message:

Some languages requested are not availble for this entry.NULL

I tried in two different days (not that makes much difference), and still got this message. So I installed again the package, and now the term is shown in portuguese alright :)

My question is: everytime that I want to use terms that were recently translated into glosario, I'll have to install the package again? Is there anyway to make this re-instalation not needed? Or I'm missing something that I should do?

Thanks!

Use case

I am trying to use glosario in a Quarto book project and I had thought to use the define functions in combination with an idea document on the quarto-cli issue tracker at: quarto-dev/quarto-cli#1697 (comment)_.

My idea would be to do the following:

[data frame]{#data_frame}

:   `r glosario::define("data_frame")`

Error

The following reproducible example shows the error I receive:

library(glosario)

packageVersion("glosario")
#> [1] '0.2'

define("tidy_data")
#> Error: Some references are slugs that are not found:
#> ref: 'geometry_shader' from slug:  'fragment_shader'
#> ref: 'tidy data' from slug:  'openrefine'
#> ref: 'geometry_shader' from slug:  'shader'
#> ref: 'data analysis' from slug:  'spectral analysis'
#> ref: 'bayesian inference' from slug:  'spectral analysis'
#> ref: 'bayesian statistics' from slug:  'spectral analysis'
#> ref: 'geometry_shader' from slug:  'tessellation_shader'
#> ref: 'geometry_shader' from slug:  'vertex_shader'
define('data_frame')
#> Error: Some references are slugs that are not found:
#> ref: 'geometry_shader' from slug:  'fragment_shader'
#> ref: 'tidy data' from slug:  'openrefine'
#> ref: 'geometry_shader' from slug:  'shader'
#> ref: 'data analysis' from slug:  'spectral analysis'
#> ref: 'bayesian inference' from slug:  'spectral analysis'
#> ref: 'bayesian statistics' from slug:  'spectral analysis'
#> ref: 'geometry_shader' from slug:  'tessellation_shader'
#> ref: 'geometry_shader' from slug:  'vertex_shader'
glosario::get_glossary()
#> Error: Some references are slugs that are not found:
#> ref: 'geometry_shader' from slug:  'fragment_shader'
#> ref: 'tidy data' from slug:  'openrefine'
#> ref: 'geometry_shader' from slug:  'shader'
#> ref: 'data analysis' from slug:  'spectral analysis'
#> ref: 'bayesian inference' from slug:  'spectral analysis'
#> ref: 'bayesian statistics' from slug:  'spectral analysis'
#> ref: 'geometry_shader' from slug:  'tessellation_shader'
#> ref: 'geometry_shader' from slug:  'vertex_shader'

^{Created on 2023-06-13 with reprex v2.0.2}

The issue is just to tell you that I used the package in R reading this YAML (which I put together from the Spanish translation for T3) and it works perfect.
I use this code:
gl <- glosario::get_glossary(url = "https://raw.githubusercontent.com/gvwilson/teachtogether.tech/master/es/glossary.yml")
glosario::define("pull_request","es", glossary = gl)
glosario::define("pull_request","en", glossary = gl)

@ian-flores ;-)