Register a board that for a website that uses the data.txt specification. A data.txt file is a YAML that provides some basic metadata about a directory of files.

board_register_datatxt(
  url,
  name = NULL,
  headers = NULL,
  cache = board_cache_path(),
  ...
)

board_datatxt(
  url,
  name = NULL,
  headers = NULL,
  cache = board_cache_path(),
  needs_index = TRUE,
  browse_url = url,
  index_updated = NULL,
  index_randomize = FALSE,
  path = NULL,
  versions = FALSE,
  ...
)

Arguments

url

Path to the data.txt file or directory containing it.

name

Board name, used to identify board in actions that affect multiple boards.

headers

Optional list of headers to include or a function to generate them.

cache

The local folder to use as a cache, defaults to board_cache_path().

...

Additional parameters stored in the board object.

needs_index

Does this board have an index file?

browse_url

Not currently used

index_updated

Callback function used to update index

index_randomize

When retrieving data.txt at a parameter with random query string to defeat caching?

path

Subdirectory within url

versions

Should this board be registered with support for versions?

See also

board_register

Examples

# register website board using datatxt file board_register_datatxt( url = "https://datatxt.org/data.txt", name = "txtexample", cache = tempfile() ) # find pins pin_find(board = "txtexample")
#> # A tibble: 2 x 4 #> name description type board #> <chr> <chr> <chr> <chr> #> 1 iris This famous (Fisher's or Anderson's) iris data set give… table txtexam… #> 2 mtcars The data was extracted from the 1974 Motor Trend US mag… table txtexam…