| get.edh {sdam} | R Documentation |
Get data from the Epigraphic Database Heidelberg API
Description
A function to obtain data from the Epigraphic Database Heidelberg REST like API repository.
Usage
get.edh(search = c("inscriptions", "geography"), url =
"https://edh.ub.uni-heidelberg.de/data/api", hd_nr,
province, country, findspot_modern, findspot_ancient,
year_not_before, year_not_after, tm_nr, transcription,
type, bbox, findspot, pleiades_id, geonames_id,
offset, limit, maxlimit = 4000, addID, printQ)
Arguments
search |
whether the search is on |
url |
open data repository API |
hd_nr |
HD number of inscription |
province |
ancient Roman province name |
country |
actual country name |
findspot_modern |
actual location name findspot |
findspot_ancient |
ancient location name findspot |
year_not_before |
year, not before (integer, BC years are negative) |
year_not_after |
year, not after (integer, BC years are negative) |
tm_nr |
trismegistos ID (integer) |
transcription |
automatic leading and trailing truncation (brackets are ignored) |
type |
type of inscription (case insensitive) |
bbox |
bounding box with character format |
findspot |
level of village, street etc. (add leading and/or trailing) |
pleiades_id |
Pleiades identifier of a place (integer) |
geonames_id |
Geonames identifier of a place (integer) |
offset |
clause to specify which row to start from retrieving data (optional and integer) |
limit |
clause to limit the number of results (optional and integer) |
maxlimit |
maximum limit of the query (integer, default 4000) |
addID |
add identification to the output? (optional and logical) |
printQ |
print also query? (optional and logical) |
Details
Since with the inscriptions option the id "component" of the
output list is not with a numeric format, then the function adds an ID
at the beginning of the list with the identifier with a numerical format.
hd_nr has not the same value as ID nor id.
In case you want to grab several items from the Epigraphic Database Heidelberg API
use function get.edhw.
A list with the of valid values from the EDH API for the ancient Roman provinces
that are also available in dataset rp are
"Ach" | Achaia | "Cor" | Corsica | "Mes" | Mesopotamia |
"Aeg" | Aegyptus | "Cre" | Creta | "MoI" | Moesia inferior |
"Aem" | Aemilia (Regio VIII) | "Cyp" | Cyprus | "MoS" | Moesia superior |
"Afr" | Africa Proconsularis | "Cyr" | Cyrene | "Nar" | Narbonensis |
"AlC" | Alpes Cottiae | "Dac" | Dacia | "Nor" | Noricum |
"AlG" | Alpes Graiae | "Dal" | Dalmatia | "Num" | Numidia |
"AlM" | Alpes Maritimae | "Epi" | Epirus | "PaI" | Pannonia inferior |
"AlP" | Alpes Poeninae | "Etr" | Etruria (Regio VII) | "PaS" | Pannonia superior |
"ApC" | Apulia et Calabria (Regio II) | "Gal" | Galatia | "Pic" | Picenum (Regio V) |
"Aqu" | Aquitania | "GeI" | Germania inferior | "Rae" | Raetia |
"Ara" | Arabia | "GeS" | Germania superior | "ReB" | Regnum Bospori |
"Arm" | Armenia | "HiC" | Hispania citerior | "Rom" | Roma |
"Asi" | Asia | "Inc" | Provincia incerta | "Sam" | Samnium (Regio IV) |
"Ass" | Assyria | "Iud" | Iudaea | "Sar" | Sardinia |
"Bae" | Baetica | "LaC" | Latium et Campania (Regio I) | "Sic" | Sicilia, Melita |
"Bar" | Barbaricum | "Lig" | Liguria (Regio IX) | "Syr" | Syria |
"Bel" | Belgica | "Lug" | Lugdunensis | "Thr" | Thracia |
"BiP" | Bithynia et Pontus | "Lus" | Lusitania | "Tra" | Transpadana (Regio XI) |
"BrL" | Bruttium et Lucania (Regio III) | "LyP" | Lycia et Pamphylia | "Tri" | Tripolitania |
"Bri" | Britannia | "MaC" | Mauretania Caesariensis | "Umb" | Umbria (Regio VI) |
"Cap" | Cappadocia | "MaT" | Mauretania Tingitana | "Val" | Valeria |
"Cil" | Cilicia | "Mak" | Macedonia | "VeH" | Venetia et Histria (Regio X) |
And the valid values for country entries are abbreviated country names where the inscription was located.
"ad" | Andorra | "gr" | Greece | "pl" | Poland |
"al" | Albania | "hr" | Croatia | "pt" | Portugal |
"am" | Armenia | "hu" | Hungary | "rks" | Kosovo |
"at" | Austria | "il" | Israel | "ro" | Romania |
"az" | Azerbaijan | "iq" | Iraq | "rs" | Serbia |
"ba" | Bosnia and Herzegovina | "it" | Italy | "ru" | Russia |
"be" | Belgium | "jo" | Jordan | "sa" | Saudi Arabia |
"bg" | Bulgaria | "kg" | Kyrgyzstan | "sd" | Sudan |
"ch" | Switzerland | "kz" | Kazakhstan | "se" | Sweden |
"cy" | Cyprus | "lb" | Lebanon | "si" | Slovenia |
"cz" | Czech Republic | "li" | Liechtenstein | "sk" | Slovakia |
"de" | Germany | "lu" | Luxembourg | "sm" | San Marino |
"dk" | Denmark | "ly" | Libyan Arab Jamahiriya | "sy" | Syrian Arab Republic |
"dz" | Algeria | "ma" | Morocco | "tj" | Tajikistan |
"eg" | Egypt | "mc" | Monaco | "tn" | Tunisia |
"es" | Spain | "md" | Moldova | "tr" | Turkey |
"fr" | France | "me" | Montenegro | "ua" | Ukraine |
"gb" | United Kingdom | "mk" | Macedonia | "uz" | Uzbekistan |
"ge" | Georgia | "mt" | Malta | "va" | Vatican City State |
"gi" | Gibraltar | "nl" | Netherlands | "ye" | Yemen |
Value
A list object with at least one the following items:
"commentary" |
|
"fotos" |
|
"country" |
|
"depth" |
|
"diplomatic_text" |
|
"edh_geography_uri" |
|
"findspot" |
|
"findspot_ancient" |
|
"findspot_modern" |
|
"geography" |
|
"height" |
|
"id" |
|
"language" |
|
"last_update" |
|
"letter_size" |
|
"literature" |
|
"material" |
|
"military" |
|
"modern_region" |
|
"not_after" |
|
"not_before" |
|
"people" |
This item is another list with at least one the following items: |
"present_location" |
|
"religion" |
|
"province_label" |
|
"responsible_individual" |
|
"social_economic_legal_history" |
|
"transcription" |
|
"trismegistos_uri" |
|
"type_of_inscription" |
|
"type_of_monument" |
|
"uri" |
|
"width" |
|
"work_status" |
|
"year_of_find" |
|
"ID" |
(Optional), only if |
The query is also printed if specified by printQ.
Warning
For queries having more than 4000 records, the server can produce a timeout break to be handled by offset.
Note
This function requires "rjson", and is for the [EDH] database [API] at the URL in references starting in year January 2022,
and changes in the URL should be updated with the url option.
Search options "photos" and "bibliography" are not supported.
Author(s)
Antonio Rivero Ostoic
References
https://edh.ub.uni-heidelberg.de/data/api
See Also
get.edhw, edhw, edhwpd, rp, plot.map, simil, rjson
Examples
## Not run:
# get inscriptions from EDH database API
get.edh(findspot_modern="madrid")
## End(Not run)