summaryrefslogtreecommitdiffstats
path: root/DESCRIPTION
diff options
context:
space:
mode:
Diffstat (limited to 'DESCRIPTION')
-rw-r--r--DESCRIPTION25
1 files changed, 25 insertions, 0 deletions
diff --git a/DESCRIPTION b/DESCRIPTION
new file mode 100644
index 0000000..c6eb473
--- /dev/null
+++ b/DESCRIPTION
@@ -0,0 +1,25 @@
+Package: cepis
+Title: Client for the Public CEP API at cep.is
+Version: 0.1.0
+Authors@R:
+ person("Murilo", "Ijanc", email = "[email protected]",
+ role = c("aut", "cre"))
+Description: Looks up Brazilian postal codes (CEP) against the public API
+ at <https://cep.is>, which serves official Correios data (DNE) refreshed
+ every two weeks. Resolves a single CEP, batches of up to 500 per request
+ with the order preserved, the coordinate the database has for about 57%
+ of them, and the API's health. Retries transient failures with
+ exponentially backed-off, jittered waits and never retries a definitive
+ answer.
+License: file LICENSE
+URL: https://cep.is
+Encoding: UTF-8
+Depends:
+ R (>= 4.0)
+Imports:
+ curl,
+ jsonlite,
+ stats,
+ utils
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2