Package: OpenMindat 1.0.1.9000

Xiang Que

OpenMindat: Quickly Retrieve Datasets from the 'Mindat' API

Provide functions for users or machines to quickly and easily retrieve datasets from the 'mindat.org' API (<https://api.mindat.org/schema/redoc/>).

Authors:Xiang Que [aut, cre], Xiaogang Ma [aut]

OpenMindat_1.0.1.9000.tar.gz
OpenMindat_1.0.1.9000.zip(r-4.7-any)OpenMindat_1.0.1.9000.zip(r-4.6-any)OpenMindat_1.0.1.9000.zip(r-4.5-any)
OpenMindat_1.0.1.9000.tgz(r-4.6-any)OpenMindat_1.0.1.9000.tgz(r-4.5-any)
OpenMindat_1.0.1.9000.tar.gz(r-4.7-any)OpenMindat_1.0.1.9000.tar.gz(r-4.6-any)
OpenMindat_1.0.1.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
OpenMindat/json (API)

# Install 'OpenMindat' in R:
install.packages('OpenMindat', repos = c('https://quexiang.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/quexiang/openmindat/issues

Pkgdown/docs site:https://quexiang.github.io

On CRAN:

Conda:

5.57 score 37 stars 4 scripts 211 downloads 135 exports 46 dependencies

Last updated from:843314b59e. Checks:7 NOTE, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develNOTE113
source / vignettesOK294
linux-releaseNOTE123
macos-releaseNOTE188
macos-oldrelNOTE168
windows-develNOTE82
windows-releaseNOTE75
windows-oldrelNOTE74
wasm-releaseOK96

Exports:ConvertDF2JsonLDConvertDF2TTLcrystalclasses_symbolscrystalclasses_systemsDana8_groupsDana8_subgroupsgeomaterials_bi_greater_thangeomaterials_bi_less_thangeomaterials_bi_rangegeomaterials_by_groupidgeomaterials_cleavagetypegeomaterials_colourgeomaterials_contain_all_but_not_elemsgeomaterials_contain_all_elemsgeomaterials_contain_any_but_not_elemsgeomaterials_contain_any_elemsgeomaterials_contain_only_elemsgeomaterials_crystal_systemgeomaterials_dens_greater_thangeomaterials_dens_less_thangeomaterials_dens_rangegeomaterials_diaphenygeomaterials_entrytypegeomaterials_expandgeomaterials_field_existsgeomaterials_fracturetypegeomaterials_hardness_gtgeomaterials_hardness_ltgeomaterials_hardness_rangegeomaterials_imageomaterials_ima_notesgeomaterials_ima_statusgeomaterials_lustretypegeomaterials_meteoritical_codegeomaterials_namegeomaterials_not_contain_elemsgeomaterials_optical2v_maxgeomaterials_optical2v_mingeomaterials_optical2v_rangegeomaterials_opticalsigngeomaterials_opticaltypegeomaterials_polytypeofgeomaterials_ri_gtgeomaterials_ri_ltgeomaterials_ri_rangegeomaterials_search_namegeomaterials_streakgeomaterials_synidgeomaterials_updated_atgeomaterials_varietyofgeomeaterials_non_utfgeomeaterials_orderinggetExtensionlocalities_list_alllocalities_list_countrylocalities_list_descriptionlocalities_list_elems_exclocalities_list_elems_inclocalities_list_elems_inc_exclocalities_list_expandlocalities_list_txtlocalities_list_updated_atlocalities_retrieve_idlocalities_status_listlocalities_status_retrievelocality_agelocality_age_listlocality_type_listLocentries_listLocentries_retrieveLocentries_stat_retrieveLocentries_statstics_listmindat_build_querystringmindat_cache_deletemindat_cache_emptymindat_cache_getmindat_cache_hasmindat_cache_return_or_setupmindat_cache_setmindat_connectionmindat_countriesmindat_countrymindat_crystalclass_listmindat_crystalclassesmindat_dana8_groupsmindat_dana8_subgroupsmindat_extract_response_bodymindat_geomaterialmindat_geomaterial_listmindat_geomaterial_searchmindat_geomaterial_varietiesmindat_get_data_from_urimindat_localities_listmindat_localitiymindat_locality_statusmindat_locality_status_listmindat_locality_typemindat_locality_type_listmindat_locentries_listmindat_locentries_lstm_idmindat_locentries_retrievemindat_locentries_statmindat_make_data_framemindat_mineral_imamindat_mineral_ima_listmindat_nickel_strunz10_classesmindat_nickel_strunz10_familiesmindat_nickel_strunz10_subclassesmindat_parse_raw_datamindat_querymindat_setupmindat_spacegroupsmindat_spacegroups_listmindat_spacegroupsetsmindat_spacegroupsets_listminerals_ima_listminerals_ima_list_expandminerals_ima_list_imaminerals_ima_retrieveNickel_strunz10_classesNickel_strunz10_familiesNickel_strunz10_subclassesparams_to_stringsaveMindatDataAsset_api_baseset_api_tokenset_page_sizespacegroups_by_idspacegroups_cclassspacegroups_listspacegroups_sgtextspacegroupsets_by_idspacegroupsets_cclassspacegroupsets_listspacegroupsets_sgtext

Dependencies:askpasscellrangerclicliprcpp11crayoncredentialscurldescfsgertgitcredsgluehmshttrhttr2inijsonlitelifecyclemagrittrmimeopensslpakpillarpkgconfigprettyunitsprogresspurrrR6rappdirsreadxlrematchrlangrprojrootrstudioapistringistringrsystibbleusethisutf8vctrswhiskerwithryamlzip

Mindat Data
Load libraries | Connect to the Mindat API | Demo 1- Map the retieved Localities that contains As | Demo 2- Map the retieved Localities within an given country | Demo 3- Map the retieved Localities that contains the input description. | Demo 4- Map the retieved Localities that contains the input description. | More Examples
Rendered fromMindat_data.Rmdusingknitr::rmarkdown

Last update: 2023-11-19
Started: 2023-06-23

OpenMindat
Get started | Load libraries | Initializing API Call | 1. Qurey Geomaterials | by chemical elements: | by physical properties: | 2. Qurey Localities | 3. Qurey IMA Minerals | 4. Save the retrieved R dataframe as a specified format file.
Rendered fromOpenMindat.Rmdusingknitr::rmarkdown

Last update: 2023-11-19
Started: 2023-06-23

Readme and manuals

Help Manual

Help pageTopics
Output file as a given formatConvertDF2JsonLD
Convert a dataframe to a string of TTL formatConvertDF2TTL
crystalclasses that match a given vector of symbols (case-insenstive)crystalclasses_symbols
crystalclasses that match a given vector of crystal system (case-insenstive)crystalclasses_systems
dana_8 classificationDana8_groups
dana_8 subgroupsDana8_subgroups
retrieve the geomaterials whose birifrigence are higher than the given value.geomaterials_bi_greater_than
retrieve the geomaterials whose birifrigence are lower density than the given value.geomaterials_bi_less_than
retrieve the geomaterials whose birifrigence are higher and lower than the given value.geomaterials_bi_range
retrieve the geomaterials by an given value of groupid.geomaterials_by_groupid
geomaterials that match an given cleavagetypegeomaterials_cleavagetype
geomaterials that have the given colorsgeomaterials_colour
geomaterials that contain all of some given elements but without any of some other given elements.geomaterials_contain_all_but_not_elems
geomaterials_contain_all_elemsgeomaterials_contain_all_elems
geomaterials that contain any of some given elements but with out any of some other given elementsgeomaterials_contain_any_but_not_elems
geomaterials that contain any one of the given elementsgeomaterials_contain_any_elems
geomaterials_contain_only_elemsgeomaterials_contain_only_elems
geomaterials that have the given crystalgeomaterials_crystal_system
retrieve the geomaterials whose density are higher than a given value.geomaterials_dens_greater_than
retrieve the geomaterials whose density are lower density than a given value.geomaterials_dens_less_than
retrieve the geomaterials whose density are within an given value.geomaterials_dens_range
retrieve the geomaterials that have an given diapheny.geomaterials_diapheny
retrieve the geomaterials that have the given entrytypegeomaterials_entrytype
retrieve the geomaterials that have the given expand.geomaterials_expand
retrieve the geomaterials records of empty or not empty of a given field.geomaterials_field_exists
retrieve the geomaterials that have the given fracturetype.geomaterials_fracturetype
retrieve the geomaterials whose hardness are higher than an given value.geomaterials_hardness_gt
retrieve the geomaterials whose hardness are lower than an given value.geomaterials_hardness_lt
retrieve the geomaterials whose hardness is within the given range.geomaterials_hardness_range
retrieve the geomaterials approved by IMA or not.geomaterials_ima
retrieve the geomaterials match given notes.geomaterials_ima_notes
retrieve the geomaterials matched given IMA status.geomaterials_ima_status
retrieve the geomaterials that match an given lustretype.geomaterials_lustretype
retrieve the geomaterials matched a given string in its meteoritical code.geomaterials_meteoritical_code
retrieve the geomaterials matched a given string in its name.geomaterials_name
geomaterials that do not contain the elementsgeomaterials_not_contain_elems
retrieve the geomaterials that less than the given optical 2v.geomaterials_optical2v_max
retrieve the geomaterials that has higher value than the given optical 2v.geomaterials_optical2v_min
retrieve the geomaterials that has the given range of optical 2v.geomaterials_optical2v_range
retrieve the geomaterials that match an given optical signs.geomaterials_opticalsign
retrieve the geomaterials that match an given optical type.geomaterials_opticaltype
retrieve the geomaterials by an given id of polytype of (the id of the mineral that this record is the polytype of. )geomaterials_polytypeof
retrieve the geomaterials that refractive index higher than an given value(gt).geomaterials_ri_gt
retrieve the geomaterials that refractive index lower than an given value(lt).geomaterials_ri_lt
retrieve the geomaterials whose refractive index is within an given range(gt,lt).geomaterials_ri_range
retrieve the geomaterials by a given name.geomaterials_search_name
retrieve the geomaterials that match an given streak.geomaterials_streak
retrieve the geomaterials by an given synid.geomaterials_synid
retrieve the geomaterials updated at an given time.geomaterials_updated_at
retrieve the geomaterials that are varieties of an given id of geomaterials.geomaterials_varietyof
retrieve the geomaterials that include non-utf mineral names or not.geomeaterials_non_utf
retrieve the geomaterials by an given ordering.geomeaterials_ordering
Output the file extension of a filenamegetExtension
retrieve the localities list.localities_list_all
retrieve the localities list that are belong to a given country.localities_list_country
retrieve the localities that contain the given descriptionlocalities_list_description
localities that do not contain the given elementslocalities_list_elems_exc
localities that contain the given elementslocalities_list_elems_inc
localities that contain the given elements but not contain some other given elements.localities_list_elems_inc_exc
localities that contain the given expands.localities_list_expand
localities that contain the given txt name.localities_list_txt
retrieve the localities list updated at the given time.localities_list_updated_at
retrieve the localities by a given mindat id.localities_retrieve_id
localities_status_listlocalities_status_list
localities_status_retrievelocalities_status_retrieve
localitiy_type_retrievelocalitiy_type_retrieve
locality_agelocality_age
locality_age_listlocality_age_list
locality_type_listlocality_type_list
retrieve a full list of locacentries.Locentries_list
retrieve locacentries by given a Locentry ID.Locentries_retrieve
retrieve locacentries statstics by given a Locentry ID.Locentries_stat_retrieve
retrieve a full list of locacentries statstics.Locentries_statstics_list
mindat_build_querystringmindat_build_querystring
Delete a cached value by the users input varnamemindat_cache_delete
Remove all cached valuesmindat_cache_empty
Get cache valuemindat_cache_get
Check if the current environment has the cached value of varname.mindat_cache_has
Check if the current environment has the cached function named varname.mindat_cache_return_or_setup
Set cache name and valuemindat_cache_set
Initializing Mindat APImindat_connection
mindat_countriesmindat_countries
mindat_countrymindat_country
mindat_crystalclass_listmindat_crystalclass_list
mindat_crystalclassesmindat_crystalclasses
mindat_dana8_groupsmindat_dana8_groups
mindat_dana8_subgroupsmindat_dana8_subgroups
mindat_extract_response_bodymindat_extract_response_body
mindat_geomaterialmindat_geomaterial
mindat_geomaterial_listmindat_geomaterial_list
mindat_geomaterial_searchmindat_geomaterial_search
mindat_geomaterial_varietiesmindat_geomaterial_varieties
mindat_get_data_from_urimindat_get_data_from_uri
mindat_localities_listmindat_localities_list
mindat_localitiymindat_localitiy
mindat_locality_statusmindat_locality_status
mindat_locality_status_listmindat_locality_status_list
mindat_locality_typemindat_locality_type
mindat_locality_type_listmindat_locality_type_list
mindat_locentries_listmindat_locentries_list
mindat_locentries_lstm_idmindat_locentries_lstm_id
mindat_locentries_retrievemindat_locentries_retrieve
mindat_locentries_statmindat_locentries_stat
mindat_make_data_framemindat_make_data_frame
mindat_mineral_imamindat_mineral_ima
mindat_mineral_ima_listmindat_mineral_ima_list
mindat_nickel_strunz10_classesmindat_nickel_strunz10_classes
mindat_nickel_strunz10_familiesmindat_nickel_strunz10_families
mindat_nickel_strunz10_subclassesmindat_nickel_strunz10_subclasses
mindat_parse_raw_datamindat_parse_raw_data
mindat_querymindat_query
mindat_setupmindat_setup
mindat_spacegroupsmindat_spacegroups
mindat_spacegroups_listmindat_spacegroups_list
mindat_spacegroupsetsmindat_spacegroupsets
mindat_spacegroupsets_listmindat_spacegroupsets_list
minerals_ima_listminerals_ima_list
minerals_ima_list_expandminerals_ima_list_expand
minerals_ima_list_imaminerals_ima_list_ima
minerals_ima_retrieveminerals_ima_retrieve
retrieve the mineral_ima list updated at the given time.minerals_ima_updated_at
Nickel-strunz10-classesNickel_strunz10_classes
Nickel-strunz10-familiesNickel_strunz10_families
Nickel-strunz10-subclassesNickel_strunz10_subclasses
params_to_stringparams_to_string
Output file as a given formatsaveMindatDataAs
set_api_baseset_api_base
set_api_tokenset_api_token
set_page_sizeset_page_size
spacegroups that match a given spacegroup ID (integer)spacegroups_by_id
spacegroups that match a given crystalclass ID (integer)spacegroups_cclass
return a full list of spacegroupsspacegroups_list
spacegroups that match a given sgtext (string)spacegroups_sgtext
spacegroupsets that match a given spacegroupets ID (integer)spacegroupsets_by_id
spacegroupsets that match a given crystalclass ID (integer)spacegroupsets_cclass
return a full list of spacegroupsetsetsspacegroupsets_list
spacegroupsets that match a given sgtext (string)spacegroupsets_sgtext