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%"
)
```

# starchart

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

The goal of starchart is to access the R-universe API.

## Installation

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

``` r
# install.packages("pak")
pak::pak("ropenscilabs/starchart")
```

## Examples

### All packages in an universe

```{r example}
library(starchart)
universe_ls("jeroen")
```

### Info on all packages in an universe

```{r}
universe_packages("jeroen", limit = 1) |>
  str(max.level = 2)
```

### Info on a single package in an universe

```{r}
universe_package("jeroen", package = "curl") |>
  str(max.level = 1)
```

### Search within a single universe

```{r}
universe_search("ropensci", query = 'needs:httr2', limit = 1) |>
  str(max.level = 2)
```

### Search among all universes

```{r}
global_search(query = '"weather data"', limit = 1) |>
  str(max.level = 2)
```