Skip to content

Commit

Permalink
docs: add kernel mode (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceyyu authored Oct 8, 2024
1 parent 2a4bf8c commit e16df64
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,30 @@ It can simplify your R data analysis and data visualization workflow, by turning
## Getting Started

### Setup GWalkR
### 📦 Setup GWalkR

```R
install.packages("GWalkR")
library(GWalkR)
```

### Start Your Data Exploration in a Single Line of Code
### 📈 Start Your Data Exploration in a Single Line of Code

```R
data(iris)
gwalkr(iris)
```

### 🚀 Switch to Kernel Computation for Large Datasets

```R
gwalkr(large_df, kernelComputation = TRUE)
```

Here is a [tutorial](https://medium.com/@bruceyu0416/eda-reimagined-in-r-gwalkr-duckdb-for-lightning-fast-visualizations-05b011e8ae39) with more details.

Please note that the kernel mode will be running in a Shiny app which will block your R console. You can stop the app to use the console.

## Main Features
### Get an overview of your data frame under 'Data' tab.
<img width="700" alt="image" src="https://github.com/bruceyyu/GWalkR/assets/33870780/67131cfa-a25b-44ae-90a0-95902ea5edb1">
Expand Down

0 comments on commit e16df64

Please sign in to comment.