Skip to content

CTTIR/harbouR

Repository files navigation

harbouR harbouR logo

Lifecycle: experimental License: MIT R-CMD-check Codecov test coverage

harbouR is an unofficial R client for the SeaTable REST API. It lets you authenticate, read, write and manage SeaTable bases entirely from R, with results returned as tidy tibbles and a column-type-aware coercion layer that makes spreadsheets feel like data frames.

SeaTable is a trademark of SeaTable GmbH; this package is not affiliated with or endorsed by SeaTable GmbH.

Installation

# install.packages("pak")
pak::pak("r-heller/harbouR")

Quick example

library(harbouR)

client <- hb_client(
  server    = Sys.getenv("SEATABLE_SERVER"),
  api_token = Sys.getenv("SEATABLE_API_TOKEN")
)

hb_list_tables(client)
samples <- hb_read_table(client, "Samples")
samples |>
  dplyr::filter(.data$Status == "ready") |>
  dplyr::arrange(.data$Collected)

Everything in harbouR also works fully offline against bundled example data — handy for exploring the data model before you connect anything:

library(harbouR)

meta <- hb_example_metadata()
tibble::as_tibble(meta)
#> # A tibble: 2 x 4
#>   name     n_rows n_columns n_views
#>   <chr>     <int>     <int>   <int>
#> 1 Samples       0         7       1
#> 2 Patients      0         4       1

hb_example_rows("Samples")

Interactive explorer

hb_run_explorer() launches a Shiny app for inspecting any base interactively, with a demo mode that needs no credentials.

About

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors