README.Rmd

---
output:
  github_document:
    html_preview: FALSE
---

<!-- 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%",
    dev = "ragg_png"
)
```

# geokit

<!-- badges: start -->
[![R-CMD-check](https://github.com/WangLabCSU/geokit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/WangLabCSU/geokit/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/WangLabCSU/geokit/graph/badge.svg)](https://app.codecov.io/gh/WangLabCSU/geokit)
<!-- badges: end -->

The goal of `geokit` is to provide a comprehensive interface for most
interactions between R and [GEO database](https://www.ncbi.nlm.nih.gov/geo/).

## Installation

You can install the development version of `geokit` from
[R-universe](https://wanglabcsu.r-universe.dev) (Recommended):
```{r, eval=FALSE}
install.packages("geokit",
    repos = c(
        "https://wanglabcsu.r-universe.dev",
        "https://cloud.r-project.org"
    )
)
```

or from [GitHub](https://github.com/WangLabCSU/geokit) (Require `rust` to
compile) with:
```{r, eval=FALSE}
if (!requireNamespace("pak")) {
    install.packages("pak",
        repos = sprintf(
            "https://r-lib.github.io/p/pak/devel/%s/%s/%s",
            .Platform$pkgType, R.Version()$os, R.Version()$arch
        )
    )
}
pak::pak("WangLabCSU/geokit")
```

## Learning geokit

Check out the [guides](https://wanglabcsu.github.io/geokit/) for learning
everything, there is to know about all the different features.