README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  fig.width = 10, 
  fig.retina = 3
)
```

# ggsegIca <img src='man/figures/logo.png' align="right" height="138.5" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/ggseg/ggsegIca/workflows/R-CMD-check/badge.svg)](https://github.com/ggseg/ggsegIca/actions)
[![DOI](https://zenodo.org/badge/417492385.svg)](https://zenodo.org/badge/latestdoi/417492385)

<!-- badges: end -->

This package contains dataset for plotting the [ica](add url here) atlas ggseg and ggseg3d. 

Beckmann, C. F., & Smith, S. M. (2004). 
Probabilistic independent component analysis for functional magneticresonance imaging. IEEE transactions on medical imaging, 23(2), 137-152.
[IEEEE](https://ieeexplore.ieee.org/document/1263605)

To learn how to use these atlases, please look at the documentation for [ggseg](https://ggseg.github.io/ggseg/) and [ggseg3d](https://ggseg.github.io/ggseg3d)

## Installation

We recommend installing the ggseg-atlases through the ggseg [r-universe](https://ggseg.r-universe.dev/ui#builds):

```{r eval = FALSE}
# Enable this universe
options(repos = c(
    ggseg = 'https://ggseg.r-universe.dev',
    CRAN = 'https://cloud.r-project.org'))

# Install some packages
install.packages('ggsegIca')
```

You can install the released version of ggsegIca from [GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("ggseg/ggsegIca")
```

```{r, fig.height=7}
library(ggseg)
library(ggseg3d)
library(ggsegIca)

plot(ica) +
  theme(legend.position = "bottom", 
        legend.text = element_text(size = 9)) +
  guides(fill = guide_legend(ncol = 6))

```

```{r "noneval", eval=FALSE}
library(dplyr)
ggseg3d(atlas = ica_3d) %>% 
  add_glassbrain() %>% 
  pan_camera("right lateral")
```

```{r "orca", include=FALSE}
library(dplyr)
p <- ggseg3d(atlas = ica_3d) %>%
  add_glassbrain(hemisphere = "left")%>%
  pan_camera("right lateral") %>%
  plotly::add_annotations( text="Screen capture",
                  legendtitle=TRUE, showarrow=FALSE,
                  font = list(color = "#000000b4",
                              family = 'sans serif',
                              size = 50))
plotly::orca(p, "man/figures/README-3d-plot.png")
```

```{r "incl", echo=FALSE}
knitr::include_graphics("man/figures/README-3d-plot.png")
```

Please note that the 'ggsegIca' project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.