# Quickly Retrieve Datasets from the 'Mindat' API

## Documentation for package ‘OpenMindat’ version 1.0.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

C D G L M N P S

## -- C --

ConvertDF2JsonLD | Output file as a given format
ConvertDF2TTL | Convert a dataframe to a string of TTL format
crystalclasses_symbols | crystalclasses that match a given vector of symbols (case-insenstive)
crystalclasses_systems | crystalclasses that match a given vector of crystal system (case-insenstive)

## -- D --

Dana8_groups | dana_8 classification
Dana8_subgroups | dana_8 subgroups

## -- G --

geomaterials_bi_greater_than | retrieve the geomaterials whose birifrigence are higher than the given value.
geomaterials_bi_less_than | retrieve the geomaterials whose birifrigence are lower density than the given value.
geomaterials_bi_range | retrieve the geomaterials whose birifrigence are higher and lower than the given value.
geomaterials_by_groupid | retrieve the geomaterials by an given value of groupid.
geomaterials_cleavagetype | geomaterials that match an given cleavagetype
geomaterials_colour | geomaterials that have the given colors
geomaterials_contain_all_but_not_elems | geomaterials that contain all of some given elements but without any of some other given elements.
geomaterials_contain_all_elems | geomaterials_contain_all_elems
geomaterials_contain_any_but_not_elems | geomaterials that contain any of some given elements but with out any of some other given elements
geomaterials_contain_any_elems | geomaterials that contain any one of the given elements
geomaterials_contain_only_elems | geomaterials_contain_only_elems
geomaterials_crystal_system | geomaterials that have the given crystal
geomaterials_dens_greater_than | retrieve the geomaterials whose density are higher than a given value.
geomaterials_dens_less_than | retrieve the geomaterials whose density are lower density than a given value.
geomaterials_dens_range | retrieve the geomaterials whose density are within an given value.
geomaterials_diapheny | retrieve the geomaterials that have an given diapheny.
geomaterials_entrytype | retrieve the geomaterials that have the given entrytype
geomaterials_expand | retrieve the geomaterials that have the given expand.
geomaterials_field_exists | retrieve the geomaterials records of empty or not empty of a given field.
geomaterials_fracturetype | retrieve the geomaterials that have the given fracturetype.
geomaterials_hardness_gt | retrieve the geomaterials whose hardness are higher than an given value.
geomaterials_hardness_lt | retrieve the geomaterials whose hardness are lower than an given value.
geomaterials_hardness_range | retrieve the geomaterials whose hardness is within the given range.
geomaterials_ima | retrieve the geomaterials approved by IMA or not.
geomaterials_ima_notes | retrieve the geomaterials match given notes.
geomaterials_ima_status | retrieve the geomaterials matched given IMA status.
geomaterials_lustretype | retrieve the geomaterials that match an given lustretype.
geomaterials_meteoritical_code | retrieve the geomaterials matched a given string in its meteoritical code.
geomaterials_name | retrieve the geomaterials matched a given string in its name.
geomaterials_not_contain_elems | geomaterials that do not contain the elements
geomaterials_optical2v_max | retrieve the geomaterials that less than the given optical 2v.
geomaterials_optical2v_min | retrieve the geomaterials that has higher value than the given optical 2v.
geomaterials_optical2v_range | retrieve the geomaterials that has the given range of optical 2v.
geomaterials_opticalsign | retrieve the geomaterials that match an given optical signs.
geomaterials_opticaltype | retrieve the geomaterials that match an given optical type.
geomaterials_polytypeof | retrieve the geomaterials by an given id of polytype of (the id of the mineral that this record is the polytype of. )
geomaterials_ri_gt | retrieve the geomaterials that refractive index higher than an given value(gt).
geomaterials_ri_lt | retrieve the geomaterials that refractive index lower than an given value(lt).
geomaterials_ri_range | retrieve the geomaterials whose refractive index is within an given range(gt,lt).
geomaterials_search_name | retrieve the geomaterials by a given name.
geomaterials_streak | retrieve the geomaterials that match an given streak.
geomaterials_synid | retrieve the geomaterials by an given synid.
geomaterials_updated_at | retrieve the geomaterials updated at an given time.
geomaterials_varietyof | retrieve the geomaterials that are varieties of an given id of geomaterials.
geomeaterials_non_utf | retrieve the geomaterials that include non-utf mineral names or not.
geomeaterials_ordering | retrieve the geomaterials by an given ordering.
getExtension | Output the file extension of a filename

## -- L --

localities_list_all | retrieve the localities list.
localities_list_country | retrieve the localities list that are belong to a given country.
localities_list_description | retrieve the localities that contain the given description
localities_list_elems_exc | localities that do not contain the given elements
localities_list_elems_inc | localities that contain the given elements
localities_list_elems_inc_exc | localities that contain the given elements but not contain some other given elements.
localities_list_expand | localities that contain the given expands.
localities_list_txt | localities that contain the given txt name.
localities_list_updated_at | retrieve the localities list updated at the given time.
localities_retrieve_id | retrieve the localities by a given mindat id.
localities_status_list | localities_status_list
localities_status_retrieve | localities_status_retrieve
localitiy_type_retrieve | localitiy_type_retrieve
locality_age | locality_age
locality_age_list | locality_age_list
locality_type_list | locality_type_list
Locentries_list | retrieve a full list of locacentries.
Locentries_retrieve | retrieve locacentries by given a Locentry ID.
Locentries_statstics_list | retrieve a full list of locacentries statstics.
Locentries_stat_retrieve | retrieve locacentries statstics by given a Locentry ID.

## -- M --

mindat_build_querystring | mindat_build_querystring
mindat_cache_delete | Delete a cached value by the users input varname
mindat_cache_empty | Remove all cached values
mindat_cache_get | Get cache value
mindat_cache_has | Check if the current environment has the cached value of varname.
mindat_cache_return_or_setup | Check if the current environment has the cached function named varname.
mindat_cache_set | Set cache name and value
mindat_connection | Initializing Mindat API
mindat_countries | mindat_countries
mindat_country | mindat_country
mindat_crystalclasses | mindat_crystalclasses
mindat_crystalclass_list | mindat_crystalclass_list
mindat_dana8_groups | mindat_dana8_groups
mindat_dana8_subgroups | mindat_dana8_subgroups
mindat_extract_response_body | mindat_extract_response_body
mindat_geomaterial | mindat_geomaterial
mindat_geomaterial_list | mindat_geomaterial_list
mindat_geomaterial_search | mindat_geomaterial_search
mindat_geomaterial_varieties | mindat_geomaterial_varieties
mindat_get_data_from_uri | mindat_get_data_from_uri
mindat_localities_list | mindat_localities_list
mindat_localitiy | mindat_localitiy
mindat_locality_status | mindat_locality_status
mindat_locality_status_list | mindat_locality_status_list
mindat_locality_type | mindat_locality_type
mindat_locality_type_list | mindat_locality_type_list
mindat_locentries_list | mindat_locentries_list
mindat_locentries_lstm_id | mindat_locentries_lstm_id
mindat_locentries_retrieve | mindat_locentries_retrieve
mindat_locentries_stat | mindat_locentries_stat
mindat_make_data_frame | mindat_make_data_frame
mindat_mineral_ima | mindat_mineral_ima
mindat_mineral_ima_list | mindat_mineral_ima_list
mindat_nickel_strunz10_classes | mindat_nickel_strunz10_classes
mindat_nickel_strunz10_families | mindat_nickel_strunz10_families
mindat_nickel_strunz10_subclasses | mindat_nickel_strunz10_subclasses
mindat_parse_raw_data | mindat_parse_raw_data
mindat_query | mindat_query
mindat_setup | mindat_setup
mindat_spacegroups | mindat_spacegroups
mindat_spacegroupsets | mindat_spacegroupsets
mindat_spacegroupsets_list | mindat_spacegroupsets_list
mindat_spacegroups_list | mindat_spacegroups_list
minerals_ima_list | minerals_ima_list
minerals_ima_list_expand | minerals_ima_list_expand
minerals_ima_list_ima | minerals_ima_list_ima
minerals_ima_retrieve | minerals_ima_retrieve
minerals_ima_updated_at | retrieve the mineral_ima list updated at the given time.

## -- N --

Nickel_strunz10_classes | Nickel-strunz10-classes
Nickel_strunz10_families | Nickel-strunz10-families
Nickel_strunz10_subclasses | Nickel-strunz10-subclasses

## -- P --

params_to_string | params_to_string

## -- S --

saveMindatDataAs | Output file as a given format
set_api_base | set_api_base
set_api_token | set_api_token
set_page_size | set_page_size
spacegroupsets_by_id | spacegroupsets that match a given spacegroupets ID (integer)
spacegroupsets_cclass | spacegroupsets that match a given crystalclass ID (integer)
spacegroupsets_list | return a full list of spacegroupsetsets
spacegroupsets_sgtext | spacegroupsets that match a given sgtext (string)
spacegroups_by_id | spacegroups that match a given spacegroup ID (integer)
spacegroups_cclass | spacegroups that match a given crystalclass ID (integer)
spacegroups_list | return a full list of spacegroups
spacegroups_sgtext | spacegroups that match a given sgtext (string)