Skip to content

Commit

Permalink
chore: update readme layout
Browse files Browse the repository at this point in the history
  • Loading branch information
shawntz committed Sep 19, 2024
1 parent 3655103 commit 2f6477b
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,25 @@ to flexibly construct and compare different pipelines.

We hope you enjoy! -shawn

```{r example, fig.width=2.5, fig.height=5, out.width='25%', fig.align='left'}
library(eyeris)
```{r example, fig.width=2.5, fig.height=5, out.width='50%', fig.align='left'}
set.seed(1)
library(eyeris)
demo_data <- system.file("extdata", "assocret.asc", package = "eyeris")
eyeris_preproc <- glassbox(demo_data) # also try setting `interactive` to TRUE
eyeris_preproc <- glassbox(demo_data, lpfilt = list(plot_freqz = TRUE))
```

### step-wise correction of pupillary signal

```{r glassbox-plot, echo = FALSE, fig.width=12, fig.height=4, out.width="50%"}
```{r glassbox-plot, echo=TRUE, fig.width=12, fig.height=4, out.width="100%"}
plot(eyeris_preproc)
```

### final pre-post correction of pupillary signal (raw -> preprocessed)

```{r timeseries-plot, echo = FALSE, fig.width=8, fig.height=5}
```{r timeseries-plot, echo=TRUE, fig.width=8, fig.height=5}
plot(eyeris_preproc, steps = c(1, 6), time_range = c(0, 100000))
```

Expand Down
69 changes: 64 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ compare different pipelines.
We hope you enjoy! -shawn

``` r
library(eyeris)

set.seed(1)

library(eyeris)

demo_data <- system.file("extdata", "assocret.asc", package = "eyeris")

eyeris_preproc <- glassbox(demo_data) # also try setting `interactive` to TRUE
eyeris_preproc <- glassbox(demo_data, lpfilt = list(plot_freqz = TRUE))
#> → Running load ...
#> → Running deblink ...
#> → Running detransient ...
Expand All @@ -62,14 +62,73 @@ eyeris_preproc <- glassbox(demo_data) # also try setting `interactive` to TRUE
#> → Running zscore ...
```

<img src="man/figures/README-example-1.png" width="25%" style="display: block; margin: auto auto auto 0;" />
<img src="man/figures/README-example-1.png" width="50%" style="display: block; margin: auto auto auto 0;" />

### step-wise correction of pupillary signal

<img src="man/figures/README-glassbox-plot-1.png" width="50%" /><img src="man/figures/README-glassbox-plot-2.png" width="50%" /><img src="man/figures/README-glassbox-plot-3.png" width="50%" /><img src="man/figures/README-glassbox-plot-4.png" width="50%" /><img src="man/figures/README-glassbox-plot-5.png" width="50%" /><img src="man/figures/README-glassbox-plot-6.png" width="50%" />
``` r
plot(eyeris_preproc)
#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2
```

<img src="man/figures/README-glassbox-plot-1.png" width="100%" />

#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2

<img src="man/figures/README-glassbox-plot-2.png" width="100%" />

#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2

<img src="man/figures/README-glassbox-plot-3.png" width="100%" />

#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2

<img src="man/figures/README-glassbox-plot-4.png" width="100%" />

#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2

<img src="man/figures/README-glassbox-plot-5.png" width="100%" />

#> [1] 1
#> [1] 2
#> [1] 2
#> [1] 2
#> [1] 3
#> [1] 2

<img src="man/figures/README-glassbox-plot-6.png" width="100%" />

### final pre-post correction of pupillary signal (raw -\> preprocessed)

``` r
plot(eyeris_preproc, steps = c(1, 6), time_range = c(0, 100000))
```

<img src="man/figures/README-timeseries-plot-1.png" width="100%" /><img src="man/figures/README-timeseries-plot-2.png" width="100%" />

# Comments, suggestions, questions, issues
Expand Down
Binary file modified man/figures/README-example-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-glassbox-plot-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2f6477b

Please sign in to comment.