Skip to content

Commit

Permalink
Added downloads badge
Browse files Browse the repository at this point in the history
  • Loading branch information
MMenchero committed Jun 12, 2024
1 parent 71b9e39 commit f676201
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ knitr::opts_chunk$set(
<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/nixtlar)](https://CRAN.R-project.org/package=nixtlar)
[![R-CMD-check](https://github.com/Nixtla/nixtlar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Nixtla/nixtlar/actions/workflows/R-CMD-check.yaml)
[![Downloads](https://cranlogs.r-pkg.org/badges/nixtlar)](https://cran.r-project.org/package=nixtlar)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-week/nixtlar)](https://cran.r-project.org/package=nixtlar)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)
<!-- badges: end -->

Expand Down
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
[![CRAN
status](https://www.r-pkg.org/badges/version/nixtlar)](https://CRAN.R-project.org/package=nixtlar)
[![R-CMD-check](https://github.com/Nixtla/nixtlar/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Nixtla/nixtlar/actions/workflows/R-CMD-check.yaml)
[![Downloads](https://cranlogs.r-pkg.org/badges/nixtlar)](https://cran.r-project.org/package=nixtlar)
[![Downloads](https://cranlogs.r-pkg.org/badges/last-week/nixtlar)](https://cran.r-project.org/package=nixtlar)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)
<!-- badges: end -->

Expand Down Expand Up @@ -46,8 +48,19 @@ users through the `nixtlar` package.

# Installation

You can install the development version of `nixtlar` from
[GitHub](https://github.com/) with:
`nixtlar` is available on CRAN, so you can install the latest stable
version using `install.packages`.

``` r
# Install nixtlar from CRAN
install.packages("nixtlar")

# Then load it
library(nixtlar)
```

Alternatively, you can install the development version of `nixtlar` from
[GitHub](https://github.com/) with `devtools::install_github`.

``` r
# install.packages("devtools")
Expand Down Expand Up @@ -145,8 +158,8 @@ nixtlar::nixtla_client_plot(df, nixtla_client_anomalies, id_col = "unique_id", p

# Features and Capabilities

`nixtlar` provides access to all of TimeGPT’s features and capabilities,
such as:
`nixtlar` provides access to TimeGPT’s features and capabilities, such
as:

- **Zero-shot Inference**: TimeGPT can generate forecasts and detect
anomalies straight out of the box, requiring no prior training data.
Expand Down Expand Up @@ -187,10 +200,12 @@ current documentation includes guides on how to:
key](https://nixtla.github.io/nixtlar/articles/get-started.html)
- [Do anomaly
detection](https://nixtla.github.io/nixtlar/articles/anomaly-detection.html)
- [Generate historical
forecasts](https://nixtla.github.io/nixtlar/articles/historical-forecast.html)
- [Perform time series
cross-validation](https://nixtla.github.io/nixtlar/articles/cross-validation.html)
- [Use exogenous
variables](https://nixtla.github.io/nixtlar/articles/exogenous-variables.html)
- [Generate historical
forecasts](https://nixtla.github.io/nixtlar/articles/historical-forecast.html)

The documentation is an ongoing effort, and we are working on expanding
its coverage.
Expand Down

0 comments on commit f676201

Please sign in to comment.