Skip to contents

Download metadata from the IFCB Dashboard API

Source: R/ifcb_download_dashboard_metadata.R
ifcb_download_dashboard_metadata.Rd

Download metadata from the IFCB Dashboard API

Usage

ifcb_download_dashboard_metadata(base_url, dataset_name = NULL, quiet = FALSE)

Arguments

base_url

Character. Base URL to the IFCB Dashboard (e.g. "https://ifcb-data.whoi.edu/").

dataset_name

Optional character. Dataset slug (e.g. "mvco") to retrieve metadata for a specific dataset. If NULL, all available metadata are downloaded.

quiet

Logical. If TRUE, suppresses progress messages. Default is FALSE.

Value

A data frame containing the exported metadata.

See also

ifcb_download_dashboard_data() to download data from the IFCB Dashboard API.

ifcb_list_dashboard_bins() to retrieve list of available bins from the IFCB Dashboard API.

Examples

# \donttest{
  # Download metadata for a specific dataset
  metadata_mvco <- ifcb_download_dashboard_metadata("https://ifcb-data.whoi.edu/",
                                                    dataset_name = "mvco",
                                                    quiet = TRUE)

  # Print result as tibble
  print(metadata_mvco)
#> # A tibble: 348,537 × 20
#>    dataset pid    sample_time          ifcb ml_analyzed latitude longitude depth
#>    <chr>   <chr>  <dttm>              <dbl>       <dbl>    <dbl>     <dbl> <dbl>
#>  1 mvco    D2017… 2017-04-14 16:31:47    10        2.57     41.3     -70.6     0
#>  2 mvco    D2017… 2017-04-14 16:54:21    10        2.46     41.3     -70.6     0
#>  3 mvco    D2017… 2017-04-14 17:16:48    10        2.70     41.3     -70.6     0
#>  4 mvco    D2017… 2017-04-14 17:39:14    10        2.69     41.3     -70.6     0
#>  5 mvco    D2017… 2017-04-14 18:01:39    10        2.75     41.3     -70.6     0
#>  6 mvco    D2017… 2017-04-14 18:24:03    10        2.82     41.3     -70.6     0
#>  7 mvco    D2017… 2017-04-14 18:46:28    10        2.63     41.3     -70.6     0
#>  8 mvco    D2017… 2017-04-14 19:08:54    10        2.74     41.3     -70.6     0
#>  9 mvco    D2017… 2017-04-14 19:31:20    10        2.85     41.3     -70.6     0
#> 10 mvco    D2017… 2017-04-14 19:53:42    10        2.67     41.3     -70.6     0
#> # ℹ 348,527 more rows
#> # ℹ 12 more variables: cruise <chr>, cast <lgl>, niskin <lgl>,
#> #   sample_type <chr>, n_images <dbl>, tag1 <chr>, tag2 <chr>, tag3 <chr>,
#> #   tag4 <chr>, comment_summary <chr>, trigger_selection <dbl>, skip <dbl>
# }