feat: default to the public corpus so the package works unconfigured
The default was a REPLACE_WITH_SHARE_TOKEN sentinel and no document in the package supplied a working URL, so a new user installing uscogdata had no path to a session at all -- just an actionable-looking error with nothing actionable behind it. The default is now the public HuggingFace mirror: CC-BY-4.0, no credential, CDN-backed, and it keeps the origin's uplink out of the read path. USCOGDATA_URL and options(uscogdata.url=) still override, so Nextcloud and cog_mirror() copies are unaffected. The sentinel guard stays for half-edited configs; the two tests covering it set the URL explicitly, so they only needed renaming to stop calling it 'the default'.
This commit is contained in:
+12
-1
@@ -5,7 +5,18 @@
|
||||
.uscogdata_env <- new.env(parent = emptyenv())
|
||||
|
||||
.uscogdata_defaults <- list(
|
||||
url = "https://cloud.civilytics.org/s/REPLACE_WITH_SHARE_TOKEN/download/",
|
||||
# Public HuggingFace mirror of the published corpus: CC-BY-4.0, no
|
||||
# credential, CDN-backed. This is the default so `library(uscogdata)`
|
||||
# followed by a verb works with zero configuration -- previously the
|
||||
# default was a REPLACE_WITH_SHARE_TOKEN sentinel and no document in the
|
||||
# package supplied a working URL, so a new user had no path to a session.
|
||||
#
|
||||
# The trailing slash is required: every consumer concatenates onto this
|
||||
# (see .resolve_url(), which enforces it anyway).
|
||||
#
|
||||
# Override with USCOGDATA_URL or options(uscogdata.url=) to read a
|
||||
# Nextcloud share or a local copy made by cog_mirror().
|
||||
url = "https://huggingface.co/datasets/civilytics/us-cog-finance/resolve/main/",
|
||||
cache_dir = NULL,
|
||||
manifest_ttl_secs = 3600L
|
||||
)
|
||||
|
||||
+1
-1
@@ -28,7 +28,7 @@
|
||||
"*" = "{.code Sys.setenv(USCOGDATA_URL = \"<url-or-local-path>/\")}",
|
||||
"*" = "{.code options(uscogdata.url = \"<url-or-local-path>/\")}",
|
||||
i = "For an offline smoke test, use the bundled fixture: {.code system.file(\"extdata/fixture_corpus\", package = \"uscogdata\")}.",
|
||||
i = "For the live Civilytics corpus, request the Nextcloud share URL from the package maintainer."
|
||||
i = "The public corpus is the default: unset USCOGDATA_URL to use it, or point it at a local copy made by {.code cog_mirror()}."
|
||||
), class = "uscogdata_url_not_configured")
|
||||
}
|
||||
invisible(url)
|
||||
|
||||
Reference in New Issue
Block a user