Module: Gbif::Species
- Defined in:
- lib/gbifrb/Species.rb
Class Method Summary collapse
-
.name_backbone(name:, rank: nil, kingdom: nil, phylum: nil, clazz: nil, order: nil, family: nil, genus: nil, strict: nil, offset: nil, limit: nil, verbose: nil, options: nil) ⇒ Hash
Search the GBIF taxonomic backbone.
-
.name_lookup(q: nil, rank: nil, higherTaxonKey: nil, status: nil, isExtinct: nil, habitat: nil, nameType: nil, datasetKey: nil, nomenclaturalStatus: nil, limit: 100, offset: nil, facet: false, facetMincount: nil, facetMultiselect: nil, type: nil, hl: false, verbosity: false, verbose: nil, options: nil) ⇒ Hash
Search the GBIF full text.
-
.name_suggest(q: nil, datasetKey: nil, rank: nil, limit: 100, offset: nil, verbose: nil, options: nil) ⇒ Hash
Search the GBIF suggester.
-
.name_usage(key: nil, name: nil, data: 'all', language: nil, datasetKey: nil, uuid: nil, sourceId: nil, rank: nil, shortname: nil, limit: 100, offset: nil, verbose: nil, options: nil) ⇒ Array
Search for GBIF name usages.
Class Method Details
.name_backbone(name:, rank: nil, kingdom: nil, phylum: nil, clazz: nil, order: nil, family: nil, genus: nil, strict: nil, offset: nil, limit: nil, verbose: nil, options: nil) ⇒ Hash
Search the GBIF taxonomic backbone
50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/gbifrb/Species.rb', line 50 def self.name_backbone(name:, rank: nil, kingdom: nil, phylum: nil, clazz: nil, order: nil, family: nil, genus: nil, strict: nil, offset: nil, limit: nil, verbose: nil, options: nil) arguments = { name: name, rank: rank, kingdom: kingdom, phylum: phylum, class: clazz, order: order, family: family, genus: genus, strict: strict, offset: offset, limit: limit }.tostrings opts = arguments.delete_if { |k, v| v.nil? } Request.new("species/match", opts, verbose, ).perform end |
.name_lookup(q: nil, rank: nil, higherTaxonKey: nil, status: nil, isExtinct: nil, habitat: nil, nameType: nil, datasetKey: nil, nomenclaturalStatus: nil, limit: 100, offset: nil, facet: false, facetMincount: nil, facetMultiselect: nil, type: nil, hl: false, verbosity: false, verbose: nil, options: nil) ⇒ Hash
Search the GBIF full text
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/gbifrb/Species.rb', line 206 def self.name_lookup(q: nil, rank: nil, higherTaxonKey: nil, status: nil, isExtinct: nil, habitat: nil, nameType: nil, datasetKey: nil, nomenclaturalStatus: nil, limit: 100, offset: nil, facet: false, facetMincount: nil, facetMultiselect: nil, type: nil, hl: false, verbosity: false, verbose: nil, options: nil) arguments = { q: q, rank: rank, higherTaxonKey: higherTaxonKey, status: status, isExtinct: isExtinct, habitat: habitat, nameType: nameType, datasetKey: datasetKey, nomenclaturalStatus: nomenclaturalStatus, limit: limit, offset: offset, facet: facet, facetMincount: facetMincount, facetMultiselect: facetMultiselect, type: type, hl: hl, verbose: verbosity }.tostrings opts = arguments.delete_if { |k, v| v.nil? } Request.new("species/search", opts, verbose, ).perform end |
.name_suggest(q: nil, datasetKey: nil, rank: nil, limit: 100, offset: nil, verbose: nil, options: nil) ⇒ Hash
Search the GBIF suggester
85 86 87 88 89 90 91 92 |
# File 'lib/gbifrb/Species.rb', line 85 def self.name_suggest(q: nil, datasetKey: nil, rank: nil, limit: 100, offset: nil, verbose: nil, options: nil) arguments = { q: q, datasetKey: datasetKey, rank: rank, limit: limit, offset: offset }.tostrings opts = arguments.delete_if { |k, v| v.nil? } Request.new("species/suggest", opts, verbose, ).perform end |
.name_usage(key: nil, name: nil, data: 'all', language: nil, datasetKey: nil, uuid: nil, sourceId: nil, rank: nil, shortname: nil, limit: 100, offset: nil, verbose: nil, options: nil) ⇒ Array
Search for GBIF name usages
126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/gbifrb/Species.rb', line 126 def self.name_usage(key: nil, name: nil, data: 'all', language: nil, datasetKey: nil, uuid: nil, sourceId: nil, rank: nil, shortname: nil, limit: 100, offset: nil, verbose: nil, options: nil) arguments = { key: key, name: name, data: data, language: language, datasetKey: datasetKey, uuid: uuid, sourceId: sourceId, rank: rank, shortname: shortname, limit: limit, offset: offset }.tostrings opts = arguments.delete_if { |k, v| v.nil? } Request.new("species/", opts, verbose, ).perform end |