Welcome!

Thank you for signing up for GoFigr! We are glad you are here. We included quick instructions for getting started below.

You can also reach out to support@gofigr.io and we will be happy to assist you.

R

To use gofigr with R, install our client from GitHub and call gfconfig():

library(devtools)
devtools::install_github("gofigr/gofigR")


> library(gofigR)
Attaching package: ‘gofigR’


> gfconfig()
-------------------------------------------------------------------


Welcome to GoFigr! This wizard will help you get up and running.


-------------------------------------------------------------------




Username: alyssa
Testing connection...


  => Success


API key (leave blank to generate a new one):
Key name (e.g. Alyssa's laptop): my API key
Fetching workspaces...


1. Scratchpad - e5249bed-40f0-4336-9bd3-fef30d3ed10d


Please select a default workspace (1-1): 1


Configuration saved to /Users/maciej/.gofigr. Happy analysis!

Then, in your setup chunk call enable():

```{r setup, include=FALSE}
library(gofigR)
gofigR::enable()
```

GoFigr will be ready to use. To sync plots, call publish (ggplot and other “modern” plotting), or publish_base (base R plots):

```{r manual_capture, fig.width=8, fig.height=8}
library(RColorBrewer)


gofigR::publish_base({
  base::plot(pressure, main="Pressure vs temperature")
  text(200, 50, "Note the non-linear relationship")
}, data=pressure, figure_name="Pressure vs temperature")


gofigR::publish_base({
  # The mtcars dataset:
  data <- as.matrix(mtcars)


  coul <- colorRampPalette(brewer.pal(8, "PiYG"))(25)
  heatmap(data, scale="column", col = coul, main="Visualizing mtcars")
}, data=mtcars, figure_name="Cars")
```


```{r correlations, fig.width=7, fig.height=7}
scatter <- ggplot(mtcars, aes(x=wt, y=mpg, color=cyl, size=cyl)) +
      geom_point() +
      theme(legend.position="none") + ggtitle("Correlations")


plot(scatter)
```

Python

First, use the terminal to install the gofigr client library and configure with gfconfig. You only need to do this once.

$ pip install gofigr
$ gfconfig
------------------------------
GoFigr configuration
------------------------------
Username: alyssa
Password:
Verifying connection...
  => Authenticated successfully
API key (leave blank to generate a new key):
Key name: Alyssa's Macbook
  => Your new API key will be saved to /Users/alyssa/.gofigr
  => Connected successfully


Please select a default workspace:
  [ 1] - Scratchpad - alyssa's personal workspace  - API ID: c6ecd353-321d-4089-b5aa-d94bf0ecb09a
Selection [1]: 1


Configuration saved to /Users/alyssa/.gofigr. Happy analysis!

Then, load the extension in Jupyter and call configure:

%load_ext gofigr
from gofigr.jupyter import *


configure(analysis=FindByName("My Analysis", create=True),
          auto_publish=True)

That’s it! Your figures will now be synced automatically.

Getting help

R readme: https://github.com/GoFigr/gofigR/blob/main/README.md

Python readme: https://github.com/GoFigr/gofigr-python/blob/main/README.rst

Please don’t hesitate to reach out to support@gofigr.io if you run into issues!