Skip to contents

Get Copernicus Marine Terminology Glossary

Source: R/cms_glossary.R
cms_glossary.Rd

Function that returns a data.frame with a glossary of terminology used by the Copernicus Marine Data Service. It is the same data.frame that is used to render vignette("glossary").

Usage

cms_glossary(search, match_fun = agrep, ...)

Arguments

Search terms to look for in the glossary data.frame. Only rows that match these terms are returned. If missing, the entire data.frame is returned.

match_fun

Function used to filter the data.frame. It needs to be a function that uses a pattern argument to match the text in the data.frame against. It should return a vector of logical values or a vector of integer row index values. By default it uses agrepl(), for a fuzzy match.

...

Arguments passed to match_fun.

Value

Returns a data.frame with glossary info.

Examples

cms_glossary("variable", ignore.case = TRUE)
#> # A tibble: 1 × 4
#>   Term      Meaning                                 Details `Example/Reference`
#>   <chr>     <chr>                                   <chr>   <chr>              
#> 1 Variables Physical quantities stored in the array NA      bottomT, thetao