Skip to content

R API Reference

r-containerio v0.3.0 runtime: py-containerio v2.4.1

Reference documentation for r-containerio, generated from the package sources on every deploy.

Function Description
bootstrap_py_runtime() Boostrap python runtime by copying default pyproject.toml and uv.lock
containerio_config() Resolves a logical container key to a concrete Azure container name and corresponding AzureStorageConfig object based on env and a TOML configuration file.
init_handler_from_toml() Creates a StorageHandler instance for the container_key based on the toml_file.
init_storage_handler() Creates a StorageHandler instance for the container name based on the given storage environment, authentication type, and AzureStorageConfig object.
list_blob_files() Lists blob files available via a storage handler created by [init_storage_handler()(init_storage_handler/) and returns their names, optionally filtered by directory (path) and a filename pattern.
options() Internally used, package-specific options.
publish_internal_r_package() [Upstream API documentation](https://forgejo.org/docs/latest/user/packages/cran/
read_csv_blob_as_df() Reads a CSV file via a storage handler created by [init_storage_handler()(init_storage_handler/) and converts the resulting Python Polars DataFrame to an R data frame.
read_excel_blob_as_df() Reads an Excel file via a storage handler created by [init_storage_handler()(init_storage_handler/) and converts the resulting Python Polars DataFrame to an R data frame.
read_json_blob_as_df() Reads a JSON file via a storage handler created by [init_storage_handler()(init_storage_handler/) and converts the resulting Python Polars DataFrame to an R data frame.
read_parquet_blob_as_df() Reads a Parquet file via a storage handler created by [init_storage_handler()(init_storage_handler/) and converts the resulting Python Polars DataFrame to an R data frame.
setup_containerio_python() In the location defined via project_path:
use_containerio_python() Points reticulate to the Python interpreter inside the local virtual environment (e.g.
write_df_to_csv_blob() Converts an R data frame to a Python Polars DataFrame and writes it as CSV via a storage handler created by [init_storage_handler()(init_storage_handler/).
write_df_to_excel_blob() Converts an R data frame to a Python Polars DataFrame and writes it as an Excel file via a storage handler created by [init_storage_handler()(init_storage_handler/).
write_df_to_json_blob() Converts an R data frame to a Python Polars DataFrame and writes it as JSON via a storage handler created by [init_storage_handler()(init_storage_handler/).
write_df_to_parquet_blob() Converts an R data frame to a Python Polars DataFrame and writes it as Parquet via a storage handler created by [init_storage_handler()(init_storage_handler/).