Package index • hipercow

Get started

Probably the order you’ll work through when starting a new hipercow project; create a new root, configure it, test that it works, and provision any packages you need.

hipercow_init(): Create a hipercow root

hipercow_configure(): Configure your hipercow root

hipercow_configuration(): Report on hipercow configuration

hipercow_hello(): Hello world

hipercow_unconfigure(): Remove a driver from a hipercow configuration

Install packages

Your cluster tasks will most likely need some packages, and you need to install them into a library.

hipercow_provision(): Provision cluster library

hipercow_provision_list() hipercow_provision_check(): List installations

hipercow_provision_compare(): Compare installations

Tasks

Create and interact with tasks.

Creation

task_create_explicit(): Create explicit task

task_create_expr(): Create a task based on an expression

task_create_call(): Create task from call

task_create_script(): Create script task

task_create_bulk_expr(): Create bulk tasks from an expression

task_create_bulk_call(): Create bulk tasks from a call

Cluster resources and parallelism

hipercow_resources(): Hipercow Resources

hipercow_resources_validate(): Validate a hipercow_resources list for a driver.

hipercow_parallel(): Specify parallel use of cores

hipercow_parallel_get_cores(): Get number of cores

hipercow_parallel_set_cores(): Set various environment variables that report the number of cores available for execution.

Interaction

task_status(): Get task status

task_result(): Get task result

task_wait(): Wait for a task to complete

task_retry(): Retry a task

task_info(): Fetch task information

task_cancel(): Cancel tasks

Logs

task_log_show() task_log_value() task_log_watch(): Get task log

Bundles of tasks

Bundles allow you to group related tasks together

hipercow_bundle_create(): Create task bundle

hipercow_bundle_load(): Load existing bundle

hipercow_bundle_list(): List existing bundles

hipercow_bundle_delete(): Delete task bundles

Interact with task bundles

These functions all have task_ analogues

hipercow_bundle_status(): Bundle status

hipercow_bundle_result(): Fetch bundle results

hipercow_bundle_wait(): Wait for a bundle to complete

hipercow_bundle_retry(): Retry task bundle

hipercow_bundle_cancel(): Cancel bundle tasks

hipercow_bundle_log_value(): Fetch bundle logs

Environments

Environments are the collections of packages and functions that we construct on a cluster machine and evaluate your tasks within. These functions let you create, update and delete these environments.