epiverse-trace / simulist

An R package for simulating line lists
https://epiverse-trace.github.io/simulist/
Other
4 stars 0 forks source link

Use `*_idx` and `*_lgl_idx` naming convention #112

Closed joshwlambert closed 1 month ago

joshwlambert commented 1 month ago

This PR addresses a comment made in PR #101, that the use of the *_idx suffix for index vectors was applied to both numeric and logical vectors (as R's subsetting works similarly for numeric and logical subsetting). This PR changes the suffix for logical index vectors from *_idx to *_lgl_idx.

The follows the same abbreviation of logical to lgl as rlang::is_lgl_na() (used in the {simulist} package since PR #111).

A new bullet point has been added to the design-principles.Rmd vignette to explain this naming convention and make it easier for contributors to correctly name index vectors.