| getSpellInfo {Aspell} | R Documentation |
This returns information about the different options that are in the specified Aspell configuration object along with details about the type of the value. This information is useful for the end user exploring the aspell library and its features. It is also used in the R code to interface to the library.
getSpellInfo(conf = createSpellConfig(), extra = TRUE, el =
createKeyInfo, order = TRUE)
conf |
the AspellConfig-class object whose options
are to be queried. |
extra |
a logical value indicating whether to return information about the “extra” keys in the option list. |
el |
a function that takes 6 arguments corresponding
to the details of the option meta data and should return
an object to represent this.
See Aspell:::createKeyInfo. |
order |
a logical value indicating whether the elements should be sorted by name or not. If you are calling this to merely get the names of the elements, this allows you to avoid the overhead of sorting the elements. |
This loops over each element in the options
list of the AspellConfig-class
object at the C-level and calls the
function given by el
to create an R object to represent it.
This returns a named list in which each
element describes the option information
for that key.
If el is NULL, only the names
of the options are returned.
Duncan Temple Lang <duncan@wald.ucdavis.edu>