Skip to contents

Errors

Every error harbouR raises carries a condition class, so callers can react to what went wrong rather than matching on message text.

harbouR-conditions
Conditions signalled by harbouR

Client & authentication

hb_client() print(<harbour_client>) format(<harbour_client>)
Create a SeaTable client
hb_ping()
Check that a SeaTable server is reachable
hb_check_credentials()
Check that the client's credentials are accepted
hb_server_info()
Server information
is_harbour_client()
Test whether an object is a harbour client

Metadata

hb_metadata()
Fetch base metadata
hb_list_tables()
List the tables in a base
hb_list_collaborators()
List collaborators of the active base
hb_column_types()
SeaTable column types and how harbouR maps them
print(<harbour_metadata>) format(<harbour_metadata>)
Print method for harbour metadata
as_tibble(<harbour_metadata>)
Coerce harbour metadata to a tibble
summary(<harbour_metadata>)
Summary of harbour metadata
is_harbour_metadata()
Test whether an object is harbour metadata

Rows

hb_read_table()
Read a table as a tibble
hb_query()
Run a SeaTable SQL query
hb_get_row()
Get a single row by ID
hb_append_rows()
Append rows to a table
hb_update_rows()
Update rows in a table
hb_delete_rows()
Delete rows
hb_lock_rows()
Lock rows
hb_unlock_rows()
Unlock rows

Tables

hb_create_table()
Create a table
hb_rename_table()
Rename a table
hb_delete_table()
Delete a table
hb_duplicate_table()
Duplicate a table

Columns

hb_list_columns()
List columns of a table
hb_add_column()
Add a column to a table
hb_add_columns()
Add several columns at once
hb_update_column()
Update a column
hb_delete_column()
Delete a column
hb_add_select_option()
Add a single-select option
hb_update_select_option()
Update a single-select option
hb_delete_select_option()
Delete a single-select option

Views

hb_list_views()
List views of a table
hb_get_view()
Get a view's settings
hb_create_view()
Create a view
hb_update_view()
Update a view
hb_delete_view()
Delete a view

Files

hb_upload_file()
Upload a file to SeaTable
hb_attach_file()
Attach a file to a cell
hb_download_file()
Download an asset
hb_delete_asset()
Delete an asset

Local .dtable files

hb_read_dtable()
Read a SeaTable .dtable file
hb_write_dtable()
Write a harbour_dtable back to a .dtable file
hb_dtable()
Build a .dtable base from data frames
hb_validate_dtable()
Check a base for problems before writing it
hb_asset_path()
Resolve a bundled asset URL to a local file
is_harbour_dtable()
Test whether an object is a harbour dtable
print(<harbour_dtable>) format(<harbour_dtable>)
Print a harbour dtable
names(<harbour_dtable>)
Names of the tables in a dtable
length(<harbour_dtable>)
Number of tables in a dtable
as_tibble(<harbour_dtable>)
Coerce a dtable's table index to a tibble
summary(<harbour_dtable>)
Summarise the schema of a dtable

Import and export

hb_write_xlsx()
Export a base to an Excel workbook
hb_write_csv()
Export a base to CSV files
hb_read_xlsx()
Read tables into a new base from an Excel workbook
hb_read_csv()
Read tables into a new base from CSV files

Example data

hb_example_metadata()
Offline example metadata
hb_example_rows()
Offline example rows

Shiny explorer

hb_run_explorer()
Launch the harbouR explorer