Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Sep 12, 2024
1 parent e32b238 commit 24355ca
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 8 deletions.
21 changes: 18 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Sys.setlocale("LC_MESSAGES", 'en_GB.UTF-8') # Force locale
[![Dependencies](https://tinyverse.netlify.app/badge/aion)](https://cran.r-project.org/package=aion)

[![r-universe](https://tesselle.r-universe.dev/badges/aion)](https://tesselle.r-universe.dev/aion){.pkgdown-devel}
[![CRAN Version](http://www.r-pkg.org/badges/version/aion)](https://cran.r-project.org/package=aion){.pkgdown-release}
[![CRAN Version](https://www.r-pkg.org/badges/version/aion)](https://cran.r-project.org/package=aion){.pkgdown-release}
[![CRAN checks](https://badges.cranchecks.info/worst/aion.svg)](https://cran.r-project.org/web/checks/check_results_aion.html){.pkgdown-release}
[![CRAN Downloads](http://cranlogs.r-pkg.org/badges/aion)](https://cran.r-project.org/package=aion){.pkgdown-release}
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/aion)](https://cran.r-project.org/package=aion){.pkgdown-release}

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

Expand Down Expand Up @@ -99,9 +99,24 @@ plot(
)
```

Plot time ranges:

```{r time-intervals, fig.width=7, fig.height=7}
## Create time intervals
Y <- intervals(
start = loire$lower,
end = loire$upper,
names = rownames(loire),
calendar = calendar("AD")
)
## Plot (default calendar)
plot(x = Y)
```

## Related Works

* [**era**](https://github.com/joeroe/era): provides a consistent representation of year-based time scales as a numeric vector with an associated era.
* [**era**](https://github.com/joeroe/era) provides a consistent representation of year-based time scales as a numeric vector with an associated era.

## Contributing

Expand Down
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@ src="https://tesselle.r-universe.dev/badges/aion"
alt="r-universe" /></a>
<a href="https://cran.r-project.org/package=aion"
class="pkgdown-release"><img
src="http://www.r-pkg.org/badges/version/aion" alt="CRAN Version" /></a>
src="https://www.r-pkg.org/badges/version/aion"
alt="CRAN Version" /></a>
<a href="https://cran.r-project.org/web/checks/check_results_aion.html"
class="pkgdown-release"><img
src="https://badges.cranchecks.info/worst/aion.svg"
alt="CRAN checks" /></a>
<a href="https://cran.r-project.org/package=aion"
class="pkgdown-release"><img src="http://cranlogs.r-pkg.org/badges/aion"
alt="CRAN Downloads" /></a>
class="pkgdown-release"><img
src="https://cranlogs.r-pkg.org/badges/aion" alt="CRAN Downloads" /></a>

[![Project Status: Active – The project has reached a stable, usable
state and is being actively
Expand Down Expand Up @@ -124,9 +125,26 @@ plot(

![](man/figures/README-time-series-1.png)<!-- -->

Plot time ranges:

``` r
## Create time intervals
Y <- intervals(
start = loire$lower,
end = loire$upper,
names = rownames(loire),
calendar = calendar("AD")
)

## Plot (default calendar)
plot(x = Y)
```

![](man/figures/README-time-intervals-1.png)<!-- -->

## Related Works

- [**era**](https://github.com/joeroe/era): provides a consistent
- [**era**](https://github.com/joeroe/era) provides a consistent
representation of year-based time scales as a numeric vector with an
associated era.

Expand Down
2 changes: 1 addition & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
comment: false

ignore:
- "R/deprecate.R"
- "R/aion-deprecated.R"
- "R/zzz.R"

coverage:
Expand Down

0 comments on commit 24355ca

Please sign in to comment.