Type:	Package
Title:	Quickly Retrieve Datasets from the 'Mindat' API
Version:	1.0.1
Imports:	httr, jsonlite (≥ 1.8.4), readxl (≥ 1.4.3), utils, stringi, stringr, usethis
Suggests:	knitr, rmarkdown, testthat (≥ 3.0.0)
Maintainer:	Xiang Que <xiangq@uidaho.edu>
Description:	Provide functions for users or machines to quickly and easily retrieve datasets from the 'mindat.org' API (https://api.mindat.org/schema/redoc/).
VignetteBuilder:	knitr
Encoding:	UTF-8
RoxygenNote:	7.3.1
URL:	https://github.com/quexiang/OpenMindat, https://quexiang.github.io/OpenMindat/
BugReports:	https://github.com/quexiang/OpenMindat/issues
License:	MIT + file LICENSE
NeedsCompilation:	no
Packaged:	2025-06-05 05:10:44 UTC; xiangque
Author:	Xiang Que [aut, cre], Xiaogang Ma [aut]
Repository:	CRAN
Date/Publication:	2025-06-05 07:40:02 UTC

OpenMindat: Quickly Retrieve Datasets from the 'Mindat' API

Description

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

Author(s)

Maintainer: Xiang Que xiangq@uidaho.edu (ORCID)

Authors:

• Xiaogang Ma max@uidaho.edu (ORCID)

See Also

Useful links:

• https://github.com/quexiang/OpenMindat

• https://quexiang.github.io/OpenMindat/

• Report bugs at https://github.com/quexiang/OpenMindat/issues

Output file as a given format

Description

Convert the mindat R dataframe to JSON-LD string

Usage

ConvertDF2JsonLD(inputdata,template = NULL)

Arguments

Examples

## Not run: 
df <-geomaterials_search_name("Quartz")
df_out <-ConvertDF2JsonLD(df)

## End(Not run)

Convert a dataframe to a string of TTL format

Description

Convert the mindat R dataframe to TTL string

Usage

ConvertDF2TTL (inputdata,template = NULL)

Arguments

Examples

## Not run: 
df <-geomaterials_search_name("Quartz")
df_out <-ConvertDF2TTL(df)

## End(Not run)

dana_8 classification

Description

: Queries a list of Dana 8th edition classifications.

Usage

Dana8_groups(...)

Arguments

Details

This function return a list of dana8 groups case-insensitive

Value

df, a data frame of dana8 groups

Examples

## Not run: 
df <-Dana8_groups()

## End(Not run)

dana_8 subgroups

Description

: Queries a list of subgroups of the Dana 8th edition classifications.

Usage

Dana8_subgroups(...)

Arguments

Details

This function return a list of dana8 subgroups case-insensitive

Value

df, a data frame of dana8 subgroups

Examples

## Not run: 
df <-Dana8_subgroups()

## End(Not run)

retrieve a full list of locacentries.

Description

: Queries locacentries.

Usage

Locentries_list(...)

Arguments

Details

This function return a list of locacentries.

Value

df, a data frame of localities

Examples

## Not run: 
df <-Locentries_list()

## End(Not run)

retrieve locacentries by given a Locentry ID.

Description

: Queries locacentries by given a ID.

Usage

Locentries_retrieve(id,...)

Arguments

Details

This function return a list of locacentries.

Value

df, a data frame of localities

Examples

## Not run: 
df <-Locentries_retrieve(2)

## End(Not run)

retrieve locacentries statstics by given a Locentry ID.

Description

: Queries locacentries locacentries statstics by given a ID.

Usage

Locentries_stat_retrieve(id,...)

Arguments

Details

This function return a list of locacentries.

Value

df, a data frame of localities

Examples

## Not run: 
df <-Locentries_stat_retrieve(2)

## End(Not run)

retrieve a full list of locacentries statstics.

Description

: Queries locacentries statstics list.

Usage

Locentries_statstics_list(...)

Arguments

Details

This function return a list of locacentries.

Value

df, a data frame of localities

Examples

## Not run: 
df <-Locentries_statstics_list()

## End(Not run)

Nickel-strunz10-classes

Description

: Queries a list of Nickel-Strunz 10th edition classifications.

Usage

Nickel_strunz10_classes(...)

Arguments

Details

This function return a list of Nickel-Strunz-10 classes. case-insensitive

Value

df, a data frame of the classes of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
df <-Nickel_strunz10_classes()

## End(Not run)

Nickel-strunz10-families

Description

: Queries a list of the families of Nickel-Strunz 10th edition classifications.

Usage

Nickel_strunz10_families(...)

Arguments

Details

This function return a list of Nickel-Strunz-10 families

Value

df, a data frame of the families of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
df <-Nickel_strunz10_families()

## End(Not run)

Nickel-strunz10-subclasses

Description

: Queries a list of the subclasses of Nickel-Strunz 10th edition classifications.

Usage

Nickel_strunz10_subclasses(...)

Arguments

Details

This function return a list of Nickel-Strunz-10 subclasses. case-insensitive

Value

df, a data frame of the subclasses of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
df <-Nickel_strunz10_subclasses()

## End(Not run)

crystalclasses that match a given vector of symbols (case-insenstive)

Description

: Queries a list of crystalclasses that match a given list of symbols

Usage

crystalclasses_symbols(symbols, ...)

Arguments

Details

This function filter data by a given list of symbols of crystal class dictionary case-insensitive

Value

df, a data frame of crystalclasses

Examples

## Not run: 
df <-crystalclasses_symbols(c("2/m","mm2"))

## End(Not run)

crystalclasses that match a given vector of crystal system (case-insenstive)

Description

: Queries a list of crystalclasses that match a given list of crystal system.

Usage

crystalclasses_systems(systems, ...)

Arguments

Details

This function filter data by a given list of crystal_system of crystal class dictionary case-insensitive

Value

df, a data frame of crystalclasses

Examples

## Not run: 
df <-geomaterials_crystal_system(c("Icosahedral"))

## End(Not run)

retrieve the geomaterials whose birifrigence are higher than the given value.

Description

: Queries the list of geomaterials that minmum value of the given birifrigence value.

Usage

geomaterials_bi_greater_than(gt, ...)

Arguments

Details

This function releated to the field "bi_min" of geomaterials. retrieve all the geomaterials that has higher birifrigence than the given value(gt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_bi_greater_than(0.2)

## End(Not run)

retrieve the geomaterials whose birifrigence are lower density than the given value.

Description

: Queries the list of geomaterials that have lower birifrigence than lt.

Usage

geomaterials_bi_less_than(lt, ...)

Arguments

Details

This function releated to the field "bi_max" of geomaterials. retrieve all the geomaterials that has higher birifrigence than the given value(lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_bi_less_than(0.3)

## End(Not run)

retrieve the geomaterials whose birifrigence are higher and lower than the given value.

Description

: Queries the list of geomaterials that have lower birifrigence than lt.

Usage

geomaterials_bi_range(gt,lt, ...)

Arguments

Details

This function releated to the fields "bi_min"and "bi_max" of geomaterials. retrieve all the geomaterials that has the birifrigence within the given range of (gt,lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_bi_range(0.2,0.3)

## End(Not run)

retrieve the geomaterials by an given value of groupid.

Description

: Queries the list of geomaterials that match an given groupid.

Usage

geomaterials_by_groupid(gid,...)

Arguments

Details

This function releated to the field "groupid" of geomaterials. retrieve all the geomaterials that match an given groupid.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_by_groupid(0)

## End(Not run)

geomaterials that match an given cleavagetype

Description

: Queries the list of geomaterials that match an given cleavagetype

Usage

geomaterials_cleavagetype(types, ...)

Arguments

Details

This function releated to the field "cleavagetype" of geomaterials. Items Enum: "Distinct/Good" "Imperfect/Fair" "None Observed" "Perfect" "Poor/Indistinct" "Very Good"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_cleavagetype(c("Poor/Indistinct"))

## End(Not run)

geomaterials that have the given colors

Description

: Queries the list of geomaterials that match a given colors.

Usage

geomaterials_colour(colors, ...)

Arguments

Details

This function releated to the field "colour" of geomaterials. For example: "Brown", "Yellow", "green", "Pink","White","Orange","Blue","Gold","Dark brown","Purple".

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_colour(c("bright blue"))

## End(Not run)

geomaterials that contain all of some given elements but without any of some other given elements.

Description

Queries the list of geomaterials that contain all the given elements listed in icl_elms, but do not contain the given elements listed in ecl_elms

Usage

geomaterials_contain_all_but_not_elems(icl_elms, ecl_elms, ...)

Arguments

Details

This function releated to the field "elements_inc" and "elements_exc" of geomaterials. This function queries the list of geological materials that contain an given list of elements (icl_elms), but not contain the other list of elements (ecl_elms). It performs the query operation by calling the mindat_geomaterial_list function.

Value

df, a data frame of geomaterials.

Examples

## Not run: 
geomaterials_contain_all_but_not_elems(c('Fe','S'), c('O'),fields ="id,name")

## End(Not run)

geomaterials_contain_all_elems

Description

retrieve the geomaterials that contain all of the elements.This function queries the list of geomaterials that contain all the given elements. It performs the query operation by calling the mindat_geomaterial_list function

Usage

geomaterials_contain_all_elems(icl_elms_vector,...)

Arguments

Details

This function releated to the field "elements_inc" of geomaterials.

Value

df, a data frame of geomaterials list.

Examples

## Not run: 
df <-geomaterials_contain_all_elems (c('Fe','S'),fields ="id,name,mindat_formula,elements")

## End(Not run)

geomaterials that contain any of some given elements but with out any of some other given elements

Description

: Queries the list of geological materials that contain any one of the given elements.

Usage

geomaterials_contain_any_but_not_elems(any_elems_vector,ecl_elms_vector,...)

Arguments

Details

This function releated to the field "elements_inc" of geomaterials. This function queries the list of geological materials that contain any element of an given list (any_elems). It performs the query operation by looping through each given element and calling the mindat_geomaterial_list function.

Value

df, a data frame of geomaterials.

Examples

## Not run: 
df <-geomaterials_contain_any_but_not_elems(c('Fe','S'), c('O'))

## End(Not run)

geomaterials that contain any one of the given elements

Description

: Queries the list of geological materials that contain any one of the given elements.

Usage

geomaterials_contain_any_elems(any_elems, ...)

Arguments

Details

This function releated to the field "elements_inc" of geomaterials. This function queries the list of geological materials that contain any element of an given list (any_elems). It performs the query operation by looping through each given element and calling the mindat_geomaterial_list function.

Value

df, a data frame of geomaterials.

Examples

## Not run: 
df <-geomaterials_contain_any_elems (c('Fe','S'),fields ="id,name,mindat_formula,elements")

## End(Not run)

geomaterials_contain_only_elems

Description

retrieve the geomaterials that only contain elements in an given list (icl_only_elms_vector).

Usage

geomaterials_contain_only_elems (icl_only_elms_vector,...)

Arguments

Details

This function releated to the fields "elements_inc" and "elements_exc" of geomaterials. Here is a list of all elements that can make up geomaterials:'H','Li', 'Be', 'B', 'C', 'N', 'O', 'F', 'Na', 'Mg', 'Al','Si', 'P', 'S','Cl',K', 'Ca', 'Sc', 'Ti', 'V', 'Cr', 'Mn', 'Fe', 'Co', 'Ni', 'Cu', 'Zn', 'Ga', 'Ge','As','Se', 'Br', 'Rb', 'Sr', 'Y', 'Zr', 'Nb', 'Mo', 'Ru', 'Rh', 'Pd', 'Ag', 'Cd','In', 'Sn', 'Sb', 'Te', 'I', 'Cs',Ba', 'La', 'Ce', 'Nd', 'Sm', 'Gd', 'Dy', 'Er','Yb', 'Hf', 'Ta', 'W', 'Re', 'Os', 'Ir', 'Pt', 'Au','Hg','Tl', 'Pb', 'Bi', 'Th', 'U' It performs the query operation by calling the mindat_geomaterial_list function

Value

df, a data frame of geomaterials.

Examples

## Not run: 
df <-geomaterials_contain_only_elems(c('Fe','S'),fields ="id,name,mindat_formula,elements")

## End(Not run)

geomaterials that have the given crystal

Description

: Queries the list of geomaterials that have the given crystal system.

Usage

geomaterials_crystal_system(crystals, ...)

Arguments

Details

This function releated to the field "crystal_system" of geomaterials. Items Enum: "Amorphous" "Hexagonal" "Icosahedral" "Isometric" "Monoclinic" "Orthorhombic" "Tetragonal" "Triclinic" "Trigonal"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_crystal_system(c("Icosahedral"))

## End(Not run)

retrieve the geomaterials whose density are higher than a given value.

Description

: Queries the list of geomaterials that have higher density than gt.

Usage

geomaterials_dens_greater_than(gt, ...)

Arguments

Details

This function releated to the field "density_min" of geomaterials. retrieve all the geomaterials that has higher density than the given density(gt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_dens_greater_than(2)

## End(Not run)

retrieve the geomaterials whose density are lower density than a given value.

Description

: Queries the list of geomaterials that have lower density than lt.

Usage

geomaterials_dens_less_than(lt, ...)

Arguments

Details

This function releated to the field "density_max" of geomaterials. retrieve all the geomaterials that has higher density than the given density(lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_dens_less_than(3)

## End(Not run)

retrieve the geomaterials whose density are within an given value.

Description

: Queries the list of geomaterials that match an given range.

Usage

geomaterials_dens_range(gt,lt, ...)

Arguments

Details

This function releated to the fields "density_min" and "density_max" of geomaterials. retrieve all the geomaterials records that has the density within an given range of (gt,lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_dens_range(2,3)

## End(Not run)

retrieve the geomaterials that have an given diapheny.

Description

: Queries the list of geomaterials that have an given diapheny.

Usage

geomaterials_diapheny(diapheny, ...)

Arguments

Details

This function releated to the field "diapheny" of geomaterials. The diaphany of the mineral(Items Enum): "Opaque" "Translucent" "Transparent"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_diapheny("Transparent")

## End(Not run)

retrieve the geomaterials that have the given entrytype

Description

: Queries the list of geomaterials that have the given entrytype

Usage

geomaterials_entrytype(types,...)

Arguments

Details

This function releated to the field "entrytype" of geomaterials. Items Enum: 0 1 2 3 4 5 6 7 8 Multiple choice: 0- mineral; 1-synonym; 2-variety; 3-mixture; 4-series; 5-grouplist; 6-polytype; 7-rock; 8-commodity Releated field: entrytype_text (description of the entrytype).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_entrytype(c('1'))

## End(Not run)

retrieve the geomaterials that have the given expand.

Description

: Queries the list of geomaterials that have the given expand.

Usage

geomaterials_expand(expanded_fields,...)

Arguments

Details

This function releated to the field "expand" of geomaterials. The field expand(Items Enum): "description" "type_localities" "localities" "relations" "~all" "*"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_expand("~all")

## End(Not run)

retrieve the geomaterials records of empty or not empty of a given field.

Description

: Queries the list of geomaterials with an empty or not empty of a given field.

Usage

geomaterials_field_exists(fieldname,bexists,...)

Arguments

Details

This function releated to all the fields of geomaterials. e.g. meteoritical_code_exists.Meteoritical code exists. Include non-empty (true) / include empty only (false) retrieve the geomaterial list with an empty or not empty of a given field.

Value

df, a list of geomaterials

Examples

## Not run: 
df <-geomaterials_field_exists("meteoritical_code")

## End(Not run)

retrieve the geomaterials that have the given fracturetype.

Description

: Queries the list of geomaterials that have the given fracturetype.

Usage

geomaterials_fracturetype(types, ...)

Arguments

Details

This function releated to the field "fracturetype" of geomaterials. fracturetype(Items Enum): "Conchoidal" "Fibrous" "Hackly" "Irregular/Uneven" "Micaceous" "None observed" "Splintery" "Step-Like" "Sub-Conchoidal"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_fracturetype(c("Step-Like"))

## End(Not run)

retrieve the geomaterials whose hardness are higher than an given value.

Description

: Queries the list of geomaterials that have higher hardness than an given value(hmin).

Usage

geomaterials_hardness_gt(hmin, ...)

Arguments

Details

This function releated to the field "hardness_min" of geomaterials. retrieve all the geomaterials that has higher hardness than the given value(hmin). hmin:the given value of minimum Moh's hardness

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_hardness_gt(8)

## End(Not run)

retrieve the geomaterials whose hardness are lower than an given value.

Description

: Queries the list of geomaterials that have lower hardness than an given vlaue(hmax).

Usage

geomaterials_hardness_lt(hmax, ...)

Arguments

Details

This function releated to the field "hardness_max" of geomaterials. retrieve all the geomaterials that has lower hardness than an given value(hmax). hamx: maximum Moh's hardness

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_hardness_lt(2)

## End(Not run)

retrieve the geomaterials whose hardness is within the given range.

Description

: Queries the list of geomaterials that have hardness within the given range.

Usage

geomaterials_hardness_range(hmin,hmax, ...)

Arguments

Details

This function releated to the fields "hardness_min" and "hardness_max" of geomaterials. retrieve all the geomaterials that has the hardness within an given range(hmin,hmax). hmin:the given value of minimum Moh's hardness hamx: maximum Moh's hardness

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_hardness_range(2,3)

## End(Not run)

retrieve the geomaterials approved by IMA or not.

Description

: Queries the geomaterials within or without the ima.

Usage

geomaterials_ima(btrue,...)

Arguments

Details

This function releated to the field "ima" of geomaterials. retrieve all the geomaterials that are approved by the IMA or not.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ima(TRUE)

## End(Not run)

retrieve the geomaterials match given notes.

Description

: Queries the geomaterials with an given .

Usage

geomaterials_ima_notes(enum_item,...)

Arguments

Details

This function releated to the field "ima_notes" of geomaterials. Rejected by the IMA; Pending approval; IMA Approved Group Name; Redefined by the IMA; Renamed by the IMA; Intermediate member of a solid-solution series; Published without approval; Unnamed (probably valid); Unnamed (probably invalid); Named Amphibole

retrieve all the geomaterials that match the input IMA notes.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ima_notes(c("PENDING_APPROVAL"))

## End(Not run)

retrieve the geomaterials matched given IMA status.

Description

: Queries the geomaterials with an given ima status.

Usage

geomaterials_ima_status(enum_status,...)

Arguments

Details

This function releated to the field "ima_status" of geomaterials. retrieve all the geomaterials that match the input IMA notes.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ima_status(c("APPROVED"))

## End(Not run)

retrieve the geomaterials that match an given lustretype.

Description

: Queries the geomaterials that match an given lustretype.

Usage

geomaterials_lustretype(types, ...)

Arguments

Details

This function releated to the field "lustretype" of geomaterials. lustretype(Items Enum): "Adamantine" "Dull" "Earthy" "Greasy" "Metallic" "Pearly" "Resinous" "Silky" "Sub-Adamantine" "Sub-Metallic" "Sub-Vitreous" "Vitreous" "Waxy" multiple choice (AND)

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_lustretype(c("Adamantine"))

## End(Not run)

retrieve the geomaterials matched a given string in its meteoritical code.

Description

: Queries the geomaterials with a given string matched its given meteoritical_code.

Usage

geomaterials_meteoritical_code(str_meteoritical_code,...)

Arguments

Details

This function releated to the field "meteoritical_code_exists" of geomaterials. Meteoritical code exists. Include non-empty (true) / include empty only (false). retrieve all the geomaterials that match the input str_meteoritical_code.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_meteoritical_code(TRUE)

## End(Not run)

retrieve the geomaterials matched a given string in its name.

Description

: Queries the geomaterials with a given name.

Usage

geomaterials_name(str_name,...)

Arguments

Details

This function releated to the field "name" of geomaterials. retrieve all the geomaterials that match the input IMA notes.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_name("qu_rtz")

## End(Not run)

geomaterials that do not contain the elements

Description

retrieve the geomaterials that do not contain any of the given elements.

Usage

geomaterials_not_contain_elems (ecl_elms_vector, ...)

Arguments

Details

This function releated to the field "elements_exc" of geomaterials.

Value

df, a data frame of geomaterials list.

Examples

## Not run: 
df <-geomaterials_not_contain_elems (c('Fe','S', 'O'), fields ="id,name,mindat_formula,elements")

## End(Not run)

retrieve the geomaterials that less than the given optical 2v.

Description

: Queries the geomaterials have the lower optical 2v value than the given lt.

Usage

geomaterials_optical2v_max(lt, ...)

Arguments

Details

This function releated to the field "optical2v_max" of geomaterials. optical2vcalc:The calculated 2V angle minimum or average of biaxial minerals optical2vcalc2:The calculated 2V angle maximum of biaxial minerals optical2vmeasured:The measured 2V angle minimum or average of biaxial minerals optical2vmeasured2:The measured 2V angle maximum of biaxial minerals

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_optical2v_max(0.2)

## End(Not run)

retrieve the geomaterials that has higher value than the given optical 2v.

Description

: Queries the geomaterials have the higher optical 2v value than the given gt.

Usage

geomaterials_optical2v_min(gt, ...)

Arguments

Details

This function releated to the field "optical2v_mix" of geomaterials. optical2vcalc:The calculated 2V angle minimum or average of biaxial minerals optical2vcalc2:The calculated 2V angle maximum of biaxial minerals optical2vmeasured:The measured 2V angle minimum or average of biaxial minerals optical2vmeasured2:The measured 2V angle maximum of biaxial minerals

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_optical2v_min(0.1)

## End(Not run)

retrieve the geomaterials that has the given range of optical 2v.

Description

: Queries the geomaterials have the higher optical 2v value than the given lt.

Usage

geomaterials_optical2v_range(gt,lt,...)

Arguments

Details

This function releated to the field "optical2v_min" and "optical2v_max" of geomaterials. optical2vcalc:The calculated 2V angle minimum or average of biaxial minerals optical2vcalc2:The calculated 2V angle maximum of biaxial minerals optical2vmeasured:The measured 2V angle minimum or average of biaxial minerals optical2vmeasured2:The measured 2V angle maximum of biaxial minerals

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_optical2v_range(0.1,0.2)

## End(Not run)

retrieve the geomaterials that match an given optical signs.

Description

: Queries the geomaterials match an given optical signs.

Usage

geomaterials_opticalsign(signs, ...)

Arguments

Details

This function releated to the field "opticalsign" of geomaterials. Optical sign: single choice (Enum): "+", "+/-", "-"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_opticalsign("-")

## End(Not run)

retrieve the geomaterials that match an given optical type.

Description

: Queries the geomaterials match an given optical type.

Usage

geomaterials_opticaltype(types, ...)

Arguments

Details

This function releated to the field "opticaltype" of geomaterials. transparent mineral. opticaltype(Enum) :"Biaxial" "Isotropic" "Uniaxial"

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_opticaltype("Isotropic")

## End(Not run)

retrieve the geomaterials by an given id of polytype of (the id of the mineral that this record is the polytype of. )

Description

: Queries the geomaterials by an given id for its polytype. A mineral that differs from another only in the stacking of similar structural units in its atomic structure

Usage

geomaterials_polytypeof(ptype, ...)

Arguments

Details

This function releated to the field "polytypeof" of geomaterials. retrieve the geomaterials with an given id of polytypeof.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_polytypeof(0,fields = "id,name,polytypeof")

## End(Not run)

retrieve the geomaterials that refractive index higher than an given value(gt).

Description

: Queries the geomaterials have the higher refractive index than an given value(gt).

Usage

geomaterials_ri_gt(gt, ...)

Arguments

Details

This function releated to the field "ri_min" of geomaterials. retrieve the geomaterials with the refractive index higher than an given value(gt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ri_gt(0.3)

## End(Not run)

retrieve the geomaterials that refractive index lower than an given value(lt).

Description

: Queries the geomaterials have the lower refractive index than an given value(lt).

Usage

geomaterials_ri_lt(lt,...)

Arguments

Details

This function releated to the field "ri_max" of geomaterials. retrieve the geomaterials with the refractive index lower than an given value(lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ri_lt(0.5)

## End(Not run)

retrieve the geomaterials whose refractive index is within an given range(gt,lt).

Description

: Queries the list of geomaterials that have refractive index within an given range(gt,lt).

Usage

geomaterials_ri_range(gt,lt, ...)

Arguments

Details

This function releated to the fields "ri_min" and "ri_max" of geomaterials. retrieve all the geomaterials that has the refractive index within the range of (gt,lt).

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_ri_range(0.2,0.5)

## End(Not run)

retrieve the geomaterials by a given name.

Description

: Queries the list of geomaterials by a given name.

Usage

geomaterials_search_name(name,...)

Arguments

Details

This function releated to the fields "name" of geomaterials. retrieve the geomaterial list that match the given name.

Value

df, a list of geomaterials

Examples

## Not run: 
df <-geomaterials_search_name("Quartz")

## End(Not run)

retrieve the geomaterials that match an given streak.

Description

: Queries the list of geomaterials that match an given steak.

Usage

geomaterials_streak(str,...)

Arguments

Details

This function releated to the fields "steak" of geomaterials. The color of the streak (color of powdered mineral). retrieve the geomaterials that has the given steak.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_streak("orange")

## End(Not run)

retrieve the geomaterials by an given synid.

Description

: Queries the list of geomaterials that match an given synid.

Usage

geomaterials_synid(idnum,...)

Arguments

Details

This function releated to the fields "synid" of geomaterials. The id of the geomaterial that is the synonym of this record (this geomaterial cannot be added to a locality). retrieve the geomaterials that has an given synid.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_synid(3777)

## End(Not run)

retrieve the geomaterials updated at an given time.

Description

: Queries the list of geomaterials that were updated at an given time

Usage

geomaterials_updated_at(strDate,...)

Arguments

Details

This function releated to the fields "updated_at" of geomaterials. Last updated datetime in format %Y-%m-%d %H:%M:%S retrieve the geomaterials that have the latest updated at the given time.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_updated_at("2020-2-12 10:15:12")

## End(Not run)

retrieve the geomaterials that are varieties of an given id of geomaterials.

Description

: Queries the list of geomaterials that match the given varietyof.

Usage

geomaterials_varietyof(intvalue,...)

Arguments

Details

This function releated to the fields "varietyof" of geomaterials. Varieties are geomaterials that have a special distinction from the main geomaterial ie. amethyst var. quartz retrieve the geomaterials that are varieties of an given id of geomaterials.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomaterials_varietyof(3337)

## End(Not run)

retrieve the geomaterials that include non-utf mineral names or not.

Description

: Queries the geomaterials include non-utf mineral names or not.

Usage

geomeaterials_non_utf(btrue =TRUE,...)

Arguments

Details

This function releated to the field "non_utf" of geomaterials. retrieve the geomaterials that contain (or not contain) the non-utf name.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomeaterials_non_utf(TRUE,fields = "id,name,non_utf")

## End(Not run)

retrieve the geomaterials by an given ordering.

Description

: Queries the geomaterials by an given ordering.

Usage

geomeaterials_ordering(ord, ...)

Arguments

Details

This function releated to the field "ordering" of geomaterials. ordering=-id - sort by id descending. Prepend "-" to the field name for descending order. fields:"approval_year" "id" "minstats__ms_locentries" "minstats__ms_photos" "name" "updttime" "weighting". retrieve the geomaterials by an given ordering.

Value

df, a data frame of geomaterials

Examples

## Not run: 
df <-geomeaterials_ordering(-id)

## End(Not run)

Output the file extension of a filename

Description

Convert the mindat R dataframe to JSON-LD string

Usage

getExtension (filename)

Arguments

Examples

filename<- "fname.txt"
fname_extension<- getExtension(filename)

retrieve the localities list.

Description

: Queries the list of localities.

Usage

localities_list_all(...)

Arguments

Details

This function releated to the fields "ids" of localities. retrieve all the localities.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_all(fields = "id,name,latitude,longitude")

## End(Not run)

retrieve the localities list that are belong to a given country.

Description

: Queries the list of localities that are within a given country.

Usage

localities_list_country(country,...)

Arguments

Details

This function releated to the field "country" of localities. Enum: "Afghanistan" "Albania" "Algeria" "American Samoa" "Andorra" "Angola" "Anguilla" "Antigua and Barbuda" "Argentina" "Armenia" "Aruba" "Ashmore and Cartier Islands" "Australia" "Austria" "Azerbaijan" "Bahamas" "Bahrain" "Bangladesh" "Barbados" "Belarus" "Belgium" "Belize" "Benin" "Bermuda" "Bhutan" "Bolivia" "Bosnia And Herzegovina" "Botswana" "Bouvet Island" "Brazil" "British Indian Ocean Territories" "British Solomon Islands" "British Virgin Islands" "Brunei" "Bulgaria" "Burkina Faso" "Burundi" "Cambodia" "Cameroon" "Canada" "Cape Verde" "Cayman Islands" "Central African Republic" "Chad" "Chile" "China" "Christmas Island" "Cocos Islands" "Colombia" "Comoro Islands" "Cook Islands" "Costa Rica" "Croatia" "Cuba" "Cyprus" "Czech Republic" "Democratic Republic of the Congo" "Denmark" "Djibouti" "Dominica" "Dominican Republic" "East Timor" "Ecuador" "Egypt" "El Salvador" "Equatorial Guinea" "Estonia" "Ethiopia" "Faeroe Islands" "Falkland Islands" "Federated States of Micronesia" "Fiji" "Finland" "France" "French Guiana" "French Polynesia" "Gabon" "Gambia" "Georgia" "Germany" "Ghana" "Gibraltar" "Greece" "Greenland" "Grenada" "Guadeloupe" "Guam" "Guatemala" "Guernsey" "Guinea" "Guinea-Bissau" "Guyana" "Haiti" "Honduras" "Hong Kong" "Hungary" "Iceland" "India" "Indonesia" "Iran" "Iraq" "Ireland" "Isle of Man" "Israel" "Italy" "Ivory Coast (Côte d'Ivoire)" "Jamaica" "Japan" "Jersey" "Jordan" "Kazakhstan" "Kenya" "Kiribati " "Kosovo" "Kuwait" "Kyrgyzstan" "Laos" "Latvia" "Lebanon" "Lesotho" "Liberia" "Libya" "Liechtenstein" "Lithuania" "Luxembourg" "Macao" "Madagascar" "Malawi" "Malaysia" "Maldives" "Mali" "Malta" "Martinique" "Mauritania" "Mauritius" "Mexico" "Moldova" "Monaco" "Mongolia" "Montenegro" "Montserrat" "Morocco" "Mozambique" "Myanmar" "Namibia" "Nauru" "Nepal" "Netherlands" "Netherlands Antilles" "New Caledonia" "New Zealand" "Nicaragua" "Niger" "Nigeria" "North Korea" "Norway" "Oman" "Pakistan" "Panama" "Papua New Guinea" "Paraguay" "Peru" "Philippines" "Poland" "Portugal" "Puerto Rico" "Qatar" "Republic of Congo (Brazzaville)" "Republic of Macedonia" "Reunion Island" "Romania" "Russia" "Rwanda" "Saint Helena" "Saint Lucia " "Saint Vincent and the Grenadines" "San Marino" "Sao Tome And Principe" "Saudi Arabia" "Senegal" "Serbia" "Seychelles" "Sierra Leone" "Singapore" "Slovakia" "Slovenia" "Solomon Islands" "Somalia" "South Africa" "South Korea" "Spain" "Sri Lanka" "St Christopher-Nevis Islands" "Sudan" "Suriname" "Swaziland" "Sweden" "Switzerland" "Syria" "Taiwan" "Tajikistan" "Tanzania" "Thailand" "Togo" "Tonga" "Trinidad And Tobago" "Tunisia" "Turkey" "Turkmenistan" "Turks And Caicos Islands" "Tuvalu" "U.S. Virgin Islands" "Uganda" "Ukraine" "United Arab Emirates" "United Kingdom" "United States" "Uruguay" "Uzbekistan" "Vanuatu (Republic of Vanuatu; New Hebrides) " "Venezuela" "Vietnam" "Western Sahara" "Western Samoa" "Yemen" "Zambia" "Zimbabwe"

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_country ("Norway")

## End(Not run)

retrieve the localities that contain the given description

Description

: Queries the list of localities that contain the given description.

Usage

localities_list_description(desc,...)

Arguments

Details

This function releated to all the field "description" of localities. retrieve the localities that contain the given description

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_description("volcano")

## End(Not run)

localities that do not contain the given elements

Description

Queries the list of localities that do not contain the given elements.

Usage

localities_list_elems_exc(exc_elems_list, ...)

Arguments

Details

This function releated to the field "elements_exc" of localities. This function queries the list of localities that do contain the specified elements.

Value

df, a data frame of localities

Examples

## Not run: 
df<-localities_list_elems_exc(c("H","O","Si","Al","Fe","Ca","Na","K","P","C","Mn","F","Mg","S"))

## End(Not run)

localities that contain the given elements

Description

Queries the list of localities that contain the given elements.

Usage

localities_list_elems_inc(inc_elems_list, ...)

Arguments

Details

This function releated to the field "elements_inc" of localities. This function queries the list of localities that contain the given elements.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_elems_inc(c("Dy"))

## End(Not run)

localities that contain the given elements but not contain some other given elements.

Description

Queries the list of localities that contain the given elements,but not contain some other given elements.

Usage

localities_list_elems_inc_exc(inc_elems_list,exc_elems_list, ...)

Arguments

Details

This function releated to the fields "elements_inc" and "elements_exc" of localities. This function queries the list of localities that contain the given elements,but not contain some other given elements.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_elems_inc_exc(c("Dy"), c("Li"))

## End(Not run)

localities that contain the given expands.

Description

Queries the list of localities that contain the given expands.

Usage

localities_list_expand(expands,...)

Arguments

Details

This function releated to the fields "expand" of localities. Items Enum: "geomaterials" "~all" "*" This function queries the list of localities that contain the given expands.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_expand("~all")

## End(Not run)

localities that contain the given txt name.

Description

Queries the list of localities that contain the given txt name.

Usage

localities_list_txt(txt,...)

Arguments

Details

This function releated to the fields "txt" of localities. This function queries the list of localities that contain the given txt name.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_txt("lava")

## End(Not run)

retrieve the localities list updated at the given time.

Description

: Queries the list of localities that have the given time

Usage

localities_list_updated_at(updateDate,...)

Arguments

Details

This function releated to all the fields "updated_at" of localities. retrieve the localities that have the latest updated at the given time.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_list_updated_at("lava")

## End(Not run)

retrieve the localities by a given mindat id.

Description

: Queries the localitiy by given id.

Usage

localities_retrieve_id(id,...)

Arguments

Details

This function releated to all the fields "id" of localities. retrieve the localities by a given id.

Value

df, a data frame of localities

Examples

## Not run: 
df <-localities_retrieve_id(3337)

## End(Not run)

localities_status_list

Description

retrieve all locality status list.

Usage

localities_status_list (...)

Arguments

Details

This function is to retrieve all the locality_status list.

Value

df, data frame of locality status

Examples

## Not run: 
df <-localities_status_list()

## End(Not run)

localities_status_retrieve

Description

retrieve locality status by its id.

Usage

localities_status_retrieve (id,...)

Arguments

Details

This function is to retrieve the locality_status by an given id of locality.

Value

df, data frame of locality status.

Examples

## Not run: 
df <-localities_status_retrieve(10)

## End(Not run)

localitiy_type_retrieve

Description

retrieve locality type by an given id of locality.

Usage

localitiy_type_retrieve (id,...)

Arguments

Details

This function is to retrieve the locality types by an given id of locality. @export

Value

df, data frame of locality status.

Examples

## Not run: 
df <-localitiy_type_retrieve(50)

## End(Not run)

locality_age

Description

retrieve locality age by its id

Usage

locality_age (id,...)

Arguments

Details

This function releated to the fields "id" of locality_age and locality.

Value

df, data frame of locality age.

Examples

## Not run: 
df <-locality_age(3337)

## End(Not run)

locality_age_list

Description

retrieve all locality age list or by its conditions

Usage

locality_age_list (...)

Arguments

Details

This function is to retrieve all the locality_age list.

Value

df, data frame of locality age.

Examples

## Not run: 
df <-locality_age_list()

## End(Not run)

locality_type_list

Description

retrieve all locality type list.

Usage

locality_type_list (...)

Arguments

Details

This function is to retrieve the locality types list.

Value

df, data frame of locality type.

Examples

## Not run: 
df <-locality_type_list()

## End(Not run)

mindat_build_querystring

Description

Build query string based on the query conditions.

Usage

mindat_build_querystring (args)

Arguments

Value

qs. generated query string.

Examples

## Not run: 
mindat_cache_set('page-size',800)
ids<-c("")
hardness_min<- 9.3
fields<- c("name,hardness")
args<- list(ids,hardness_min,fields)
querystring<-mindat_build_querystring(args)

## End(Not run)

Delete a cached value by the users input varname

Description

Remove (clear) the cache named varname in current environment.

Usage

mindat_cache_delete(varname)

Arguments

Examples

mindat_cache_delete('api_token')

Remove all cached values

Description

Clear all current cached values. Set current environment cache empty.

Usage

mindat_cache_empty()

Examples

mindat_cache_empty()

Get cache value

Description

Retrieve the value of the cache named varname in current environment.

Usage

mindat_cache_get(varname)

Arguments

Value

cached value. A string, list or other objects.

Examples

token<- mindat_cache_get('api_token')

Check if the current environment has the cached value of varname.

Description

Check whether or not the current environment has the cache named varname.

Usage

mindat_cache_has(varname)

Arguments

Value

Boolean value. if the varname is found in current environment cache, return True otherwise return False.

Examples

b_has <- mindat_cache_has('api_token')

Check if the current environment has the cached function named varname.

Description

Check whether the current environment has the cached function named varname,if has, return it. if not, setup up a new cache function named varname.

Usage

mindat_cache_return_or_setup(varname,setupfun)

Arguments

Value

If the varname is found in current environment cache, return cached function. If not, eval the function and return cached function.

Examples

 aep<-  api_end_points<-mindat_cache_return_or_setup('api_end_points', function(){return (list()) })

Set cache name and value

Description

Assigns the value to the cache named varname in current environment.

Usage

mindat_cache_set(varname, value)

Arguments

Examples

mindat_cache_set('api_token',"9ce67655d74bcd981e937be80dcea9cb")

Initializing Mindat API

Description

Initializing API Call. Setup the base_url, token and format.

Usage

mindat_connection(token, base_url = "https://api.mindat.org/v1",page_size = 800)

Arguments

Examples

mindat_connection("9ce67655d74bcd981e937be80dcea9cb",page_size = 1500)

mindat_countries

Description

retrieve all countries list or the contries by given conditions.

Usage

mindat_countries (...)

Arguments

Value

df, data frame of countries list

Examples

## Not run: 
 df<- mindat_countries()

## End(Not run)

mindat_country

Description

retrieve the country by given its id.

Usage

mindat_country (id,...)

Arguments

Value

df, a data frame of country

Examples

## Not run: 
 df<- mindat_country(1)

## End(Not run)

mindat_crystalclass_list

Description

retrieve all the crystalclasses list or the crystalclasses list by given conditions.

Usage

mindat_crystalclass_list(...)

Arguments

Value

df, data frame of crystalclasses list

Examples

## Not run: 
 df<- mindat_crystalclass_list()

## End(Not run)

mindat_crystalclasses

Description

retrieve crystalclasses by its id

Usage

mindat_crystalclasses (id,...)

Arguments

Value

df, data frame of crystalclasses

Examples

## Not run: 
 df<- mindat_crystalclasses(4)

## End(Not run)

mindat_dana8_groups

Description

retrieve all the classifications of dana8.

Usage

mindat_dana8_groups(...)

Arguments

Value

df, data frame of dana8 classification list

Examples

## Not run: 
 df<- mindat_dana8_groups()

## End(Not run)

mindat_dana8_subgroups

Description

retrieve all the subgroups of dana8.

Usage

mindat_dana8_subgroups(...)

Arguments

Value

df, data frame of subgroups of dana8 classification.

Examples

## Not run: 
 df<- mindat_dana8_subgroups()

## End(Not run)

mindat_extract_response_body

Description

.

Usage

mindat_extract_response_body (response)

Arguments

Value

if status of the response is sucess (200),return the all_data_text(the content of response). Otherwise,report the errors.

Examples

## Not run: 
library(httr)
uri<- "https://api.mindat.org/v1/geomaterials/?id_in=&hardness_min=9.3&fields=name,+
hardness&page_size=1500"
api_token<- "9ce67655d74bcd981e937be80dcea9cb"
response <- GET(uri,add_headers('Authorization'= paste('Token ',api_token,sep = "")))
raw_data <- mindat_extract_response_body(response)

## End(Not run)

mindat_geomaterial

Description

retrieve geomaterial by its id

Usage

mindat_geomaterial (id,...)

Arguments

Value

df, data frame of locality type list

Examples

## Not run: 
 df<- mindat_geomaterial(3337)

## End(Not run)

mindat_geomaterial_list

Description

retrieve all the geomaterial list or the geomaterial by given conditions.

Usage

mindat_geomaterial_list(...)

Arguments

Value

df, data frame of locality type list

Examples

## Not run: 
 df<- mindat_geomaterial_list()

## End(Not run)

mindat_geomaterial_search

Description

retrieve all the geomaterial list or the geomaterial by given conditions.

Usage

mindat_geomaterial_search (...)

Arguments

Value

df, data frame of geomaterials mathch the search

Examples

## Not run: 
 df<- mindat_geomaterial_search(q="Quartz")

## End(Not run)

mindat_geomaterial_varieties

Description

retrieve the geomaterial varieties by the id of geomaterial.

Usage

mindat_geomaterial_varieties (id,...)

Arguments

Value

df, data frame of locality type list

Examples

## Not run: 
 df<- mindat_geomaterial_varieties(3337)

## End(Not run)

mindat_get_data_from_uri

Description

retrieve data from the uri.

Usage

mindat_get_data_from_uri (uri)

Arguments

Value

df. R data frame of the request uri.

Examples

## Not run: 
library(httr)
uri <- "https://api.mindat.org/geomaterials/?id__in=&hardness_min=9.3&fields=name,+
hardness&page-size=1500"
mindat_cache_set('api_token',"9ce67655d74bcd981e937be80dcea9cb")
df <- mindat_get_data_from_uri(uri)

## End(Not run)

mindat_localities_list

Description

retrieve localities list

Usage

mindat_localities_list (...)

Arguments

Value

df. data frame of localities list.

Examples

## Not run: 
 df<- mindat_localities_list()

## End(Not run)

mindat_localitiy

Description

retrieve locality by its id

Usage

mindat_localitiy (id,...)

Arguments

Value

df, data frame of locality

Examples

## Not run: 
 df<- mindat_localitiy(3337)

## End(Not run)

mindat_locality_status

Description

retrieve all locality status by its id

Usage

mindat_locality_status (id,...)

Arguments

Value

df, data frame of locality status

Examples

## Not run: 
 df<- mindat_locality_status(10)

## End(Not run)

mindat_locality_status_list

Description

retrieve all locality status list

Usage

mindat_locality_status_list (...)

Arguments

Value

df, data frame of locality status list

Examples

## Not run: 
 df<- mindat_locality_status_list()

## End(Not run)

mindat_locality_type

Description

retrieve locality type by its id

Usage

mindat_locality_type (id,...)

Arguments

Value

df, data frame of locality type list

Examples

## Not run: 
 df<- mindat_locality_type(50)

## End(Not run)

mindat_locality_type_list

Description

retrieve all locality type list

Usage

mindat_locality_type_list (...)

Arguments

Value

df, data frame of locality type list

Examples

## Not run: 
 df<- mindat_locality_type_list()

## End(Not run)

mindat_locentries_list

Description

retrieve Mindat locentries. A 'locentry' is a record of specific geomaterial (mineral, etc) at a specific locality.

Usage

mindat_locentries_list (...)

Arguments

Value

df, data frame of locentries list.

Examples

## Not run: 
 df<- mindat_locentries_list()

## End(Not run)

mindat_locentries_lstm_id

Description

retrieve Mindat locality-geomaterial pairs and some statistics list.

Usage

mindat_locentries_lstm_id (id,...)

Arguments

Value

df, data frame of locentries statstics list.

Examples

## Not run: 
 df<- mindat_locentries_lstm_id(2)

## End(Not run)

mindat_locentries_retrieve

Description

retrieve Mindat locentries by a given ID. A 'locentry' is a record of specific geomaterial (mineral, etc) at a specific locality.

Usage

mindat_locentries_retrieve (id,...)

Arguments

Value

df, data frame of locentries list.

Examples

## Not run: 
 df<- mindat_locentries_retrieve(2)

## End(Not run)

mindat_locentries_stat

Description

retrieve Mindat locality-geomaterial pairs and some statistics list.

Usage

mindat_locentries_stat (...)

Arguments

Value

df, data frame of locentries statstics list.

Examples

## Not run: 
 df<- mindat_locentries_stat()

## End(Not run)

mindat_make_data_frame

Description

convert the response json to dataframe of R

Usage

mindat_make_data_frame (reg_list)

Arguments

Value

df_out, R data frame

Examples

## Not run: 
id<- c('42155','9300','11282','48322')
name<-  c('Cuarzo opalescente', 'Cupromagnesite', 'Cuprozippeite', 'Quartz-anorthosite')
ima_status <- c(0,0,0,0)
synid <- c(42133, 9281, 0, 0)
list_cvt <- list(id=id, name=name, ima_status=ima_status, synid=synid)
df<- mindat_make_data_frame(list_cvt)

## End(Not run)

mindat_mineral_ima

Description

retrieve ima mineral by its id.

Usage

mindat_mineral_ima (id,...)

Arguments

Value

df. query resutls in data frame format.

Examples

## Not run: 
 df<- mindat_mineral_ima(3337)

## End(Not run)

mindat_mineral_ima_list

Description

retrieve ima mineral list

Usage

mindat_mineral_ima_list (...)

Arguments

Value

df, data frame of mineral list.

Examples

## Not run: 
 df<- mindat_mineral_ima_list()

## End(Not run)

mindat_nickel_strunz10_classes

Description

retrieve the class list of Nickel-Strunz 10th edition classifications.

Usage

mindat_nickel_strunz10_classes(...)

Arguments

Value

df, data frame of classes of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
 df<- mindat_nickel_strunz10_classes()

## End(Not run)

mindat_nickel_strunz10_families

Description

retrieve the families list of Nickel-Strunz 10th edition classifications.

Usage

mindat_nickel_strunz10_families(...)

Arguments

Value

df, data frame of families of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
 df<- mindat_nickel_strunz10_families()

## End(Not run)

mindat_nickel_strunz10_subclasses

Description

retrieve the subclass list of Nickel-Strunz 10th edition classifications.

Usage

mindat_nickel_strunz10_subclasses(...)

Arguments

Value

df, data frame of subclasses of Nickel-Strunz 10th edition classifications.

Examples

## Not run: 
 df<- mindat_nickel_strunz10_subclasses()

## End(Not run)

mindat_parse_raw_data

Description

parse the raw response of json to dataframe of R. If the raw_data obtained from the response is paged, request all the pages and then add them into the df_out data frame.

Usage

mindat_parse_raw_data (raw_data)

Arguments

Value

df_out, R data frame

Examples

## Not run: 
rd<-"{\"count\":5,\"next\":null,\"previous\":null,+
\"results\":[{\"name\":\"Diamond\"},{\"name\":\"Khamrabaevite\"},+
{\"name\":\"Moissanite\"},{\"name\":\"Qingsongite\"},{\"name\":\"Uakitite\"}]}"
df<- mindat_parse_raw_data(rd)

## End(Not run)

mindat_query

Description

Basic function for query dataset at a specified endpoit.

Usage

mindat_query (endpoint, query = list())

Arguments

Value

df query resutls in data frame format.

Examples

## Not run: 
df <-mindat_query("geomaterials_list",list(ids="",hardness_min=9))

## End(Not run)

mindat_setup

Description

set up of the mindat basic uri, endpoints, and cache

Usage

mindat_setup(base_uri = 'https://api.mindat.org/v1',page_size = 800)

Arguments

Examples

## Not run: 
mindat_setup()

## End(Not run)

mindat_spacegroups

Description

retrieve spacegroups by its id

Usage

mindat_spacegroups (id,...)

Arguments

Value

df, data frame of spacegroups

Examples

## Not run: 
 df<- mindat_spacegroups(4)

## End(Not run)

mindat_spacegroups_list

Description

retrieve all the spacegroups list or the spacegroups list by given conditions.

Usage

mindat_spacegroups_list(...)

Arguments

Value

df, data frame of spacegroups list

Examples

## Not run: 
 df<- mindat_spacegroups_list()

## End(Not run)

mindat_spacegroupsets

Description

retrieve spacegroups by its id

Usage

mindat_spacegroupsets (id,...)

Arguments

Value

df, data frame of spacegroupsets

Examples

## Not run: 
 df<- mindat_spacegroupsets(4)

## End(Not run)

mindat_spacegroupsets_list

Description

retrieve all the spacegroups list or the spacegroups list by given conditions.

Usage

mindat_spacegroupsets_list(...)

Arguments

Value

df, data frame of spacegroupsets list

Examples

## Not run: 
 df<- mindat_spacegroups_list()

## End(Not run)

minerals_ima_list

Description

retrieve all mineral ima list.

Usage

minerals_ima_list (...)

Arguments

Details

This function is to retrieve the IMA minerals list.

Value

df, data frame of minerals.

Examples

## Not run: 
df <-minerals_ima_list()

## End(Not run)

minerals_ima_list_expand

Description

retrieve mineral ima list with the given expand.

Usage

minerals_ima_list_expand (expand,...)

Arguments

Details

This function is related to the filed "expand" of ima mineral. Items Enum: "~all" "*"

Value

df, data frame of ima minerals with expanded fields.

Examples

## Not run: 
df <-minerals_ima_list_expand("~all")

## End(Not run)

minerals_ima_list_ima

Description

retrieve mineral ima list with the given intValue.

Usage

minerals_ima_list_ima (intValue,...)

Arguments

Details

This function is related to the filed "ima" of ima minerals. Integer. 0: "PENDING_PUBLICATION" 1: "APPROVED"

Value

df, data frame of locality type.

Examples

## Not run: 
df <-minerals_ima_list_ima(1)

## End(Not run)

minerals_ima_retrieve

Description

retrieve mineral ima by its id.

Usage

minerals_ima_retrieve (id,...)

Arguments

Details

This function is related to the filed "id" of ima minerals.

Value

df, data frame of ima mineral by a given id.

Examples

## Not run: 
df <-minerals_ima_retrieve(3337)

## End(Not run)

retrieve the mineral_ima list updated at the given time.

Description

: Queries the list of mineral_ima that have the given time

Usage

minerals_ima_updated_at(updateDate,...)

Arguments

Details

This function is related to the filed "updated_at" of ima minerals. retrieve the localities that have the latest updated at the given time.

Value

df, a data frame of localities

Examples

## Not run: 
df <-minerals_ima_updated_at("2020-11-10 10:12:20")

## End(Not run)

params_to_string

Description

Prase params to string,so that the query function can deal with the other exteranl condition set by the users.

Usage

params_to_string (params)

Arguments

Value

str .

Examples

## Not run: 
 params_to_string("")

## End(Not run)

Output file as a given format

Description

Save the mindat R dataframe to a specify format

Usage

saveMindatDataAs (inputdata,outputfname)

Arguments

Examples

## Not run: 
df <-geomaterials_search_name("Quartz")
saveMindatDataAs(df,"test.jsonld")

## End(Not run)

set_api_base

Description

set base uri of current environment

Usage

set_api_base (api_base)

Arguments

Examples

set_api_base("9ce67655d74bcd981e937be80dcea9cb")

set_api_token

Description

set the token of current environment

Usage

set_api_token (api_token)

Arguments

Examples

set_api_token("9ce67655d74bcd981e937be80dcea9cb")

set_page_size

Description

set the page_size of response records.

Usage

set_page_size (page_size)

Arguments

Examples

set_page_size(800)

spacegroups that match a given spacegroup ID (integer)

Description

: Queries a list of spacegroup that match a given spacegroup ID

Usage

spacegroups_by_id(spacegroup_id, ...)

Arguments

Details

This function filter data by a given given spacegroup ID.

Value

df, a data frame of spacegroup

Examples

## Not run: 
df <-spacegroups_by_id(2)

## End(Not run)

spacegroups that match a given crystalclass ID (integer)

Description

: Queries a list of spacegroup that match a given crystalclass ID

Usage

spacegroups_cclass(crystalclass_id, ...)

Arguments

Details

This function filter data by a given given crystalclass ID.

Value

df, a data frame of spacegroup

Examples

## Not run: 
df <-spacegroups_cclass(2)

## End(Not run)

return a full list of spacegroups

Description

: Queries a full list of spacegroup

Usage

spacegroups_list(...)

Arguments

Details

This function return a full list of spacegroups.

Value

df, a data frame of the full list of spacegroups

Examples

## Not run: 
df <-spacegroups_list()

## End(Not run)

spacegroups that match a given sgtext (string)

Description

: Queries a list of spacegroups that match a given sgtext (string)

Usage

spacegroups_sgtext(sgtext, ...)

Arguments

Details

This function filter data by a given given crystalclass ID.

Value

df, a data frame of spacegroups

Examples

## Not run: 
df <-spacegroups_sgtext("P1")

## End(Not run)

spacegroupsets that match a given spacegroupets ID (integer)

Description

: Queries a list of spacegroupsets that match a given spacegroupets ID

Usage

spacegroupsets_by_id(spacegroupsets_id, ...)

Arguments

Details

This function filter data by a given given spacegroup ID.

Value

df, a data frame of spacegroupsets

Examples

## Not run: 
df <-spacegroupsets_by_id(2)

## End(Not run)

spacegroupsets that match a given crystalclass ID (integer)

Description

: Queries a list of spacegroupsets that match a given crystalclass ID

Usage

spacegroupsets_cclass(crystalclass_id, ...)

Arguments

Details

This function filter data by a given given crystalclass ID.

Value

df, a data frame of spacegroup

Examples

## Not run: 
df <-spacegroupsets_cclass(2)

## End(Not run)

return a full list of spacegroupsetsets

Description

: Queries a full list of spacegroupsets

Usage

spacegroupsets_list(...)

Arguments

Details

This function return a full list of spacegroupsets.

Value

df, a data frame of the full list of spacegroupsets

Examples

## Not run: 
df <-spacegroupsets_list()

## End(Not run)

spacegroupsets that match a given sgtext (string)

Description

: Queries a list of spacegroupsets that match a given sgtext (string)

Usage

spacegroupsets_sgtext(sgtext, ...)

Arguments

Details

This function filter data by a given given crystalclass ID.

Value

df, a data frame of spacegroupsets

Examples

## Not run: 
df <-spacegroupsets_sgtext("P1")

## End(Not run)