Orchestrate and Exchange Data with 'EtherCalc' Instances
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.5 KiB

---
output: rmarkdown::github_document
editor_options:
chunk_output_type: inline
---
```{r pkg-knitr-opts, include=FALSE}
knitr::opts_chunk$set(collapse=TRUE, fig.retina=2, message=FALSE, warning=FALSE)
options(width=120)
```

[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/ethercalc.svg?branch=master)](https://travis-ci.org/hrbrmstr/ethercalc)
[![Coverage Status](https://codecov.io/gh/hrbrmstr/ethercalc/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/ethercalc)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/ethercalc)](https://cran.r-project.org/package=ethercalc)

# ethercalc

Orchestrate and Exchange Data with 'EtherCalc' Instances

## Description

The 'EtherCalc' (<https://ethercalc.net/>) web application is a multi-user,
collaborative spreadsheet that can be run locally on virtually any modern operating system. Methods are provided to orchestrate and exchange data with 'EtherCalc' instances.

![](man/figures/ethercalc-example.gif)

## What's Inside The Tin

The following functions are implemented:


- `ec_append`: Append a data frame to a "room", optionally starting at a given row
- `ec_cmd`: Issue EtherCalc "commands" to a room
- `ec_delete`: Delete a "room" from an EtherCalc instance
- `ec_edit`: Edit a data frame in a new or existing EtherCalc "room"
- `ec_exists`: Does an EtherCalc "room" name exist?
- `ec_export`: Export an EtherCalc "room" to a local file
- `ec_list`: List all of the available EtherCalc documents
- `ec_new`: Create a new, empty EtherCalc "room"
- `ec_read`: Read an EtherCalc "room" to a local data frame
- `ec_running`: Export an EtherCalc "room" to a local data frame
- `ec_start`: Start an EtherCalc instance (requires you to install EtherCalc first)
- `ec_view`: Open a browser window/tab to an EtherCalc "room"
- `ethercalc_host`: Get or set ETHERCALC_HOST value

## Installation

```{r install-ex, eval=FALSE}
devtools::install_git("https://git.sr.ht/~hrbrmstr/ethercalc.git")
# or
devtools::install_git("https://git.rud.is/hrbrmstr/ethercalc.git")
# or
devtools::install_gitlab("hrbrmstr/ethercalc")
# or
devtools::install_bitbucket("hrbrmstr/ethercalc")
# or
devtools::install_github("hrbrmstr/ethercalc")
```

## Usage

```{r lib-ex}
library(ethercalc)

# current version
packageVersion("ethercalc")

```

## ethercalc Metrics

```{r cloc, echo=FALSE}
cloc::cloc_pkg_md()
```

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md).
By participating in this project you agree to abide by its terms.