README.Rmd

---
output: github_document
---

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

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

# A Class for Week Numbers

<!-- badges: start -->
[![R build status](https://github.com/hmalmedal/weeknumber/workflows/R-CMD-check/badge.svg)](https://github.com/hmalmedal/weeknumber/actions)
<!-- badges: end -->

A class for week numbers, according to ISO 8601.

## Documentation

* https://hmalmedal.github.io/weeknumber/

## Installation

Install from [GitHub](https://github.com/hmalmedal/weeknumber):

```{r gh-installation, eval = FALSE}
remotes::install_github("hmalmedal/weeknumber")
```

## Examples

Coercion to the week number class:

```{r coercion, message=FALSE}
library(weeknumber)
as_weeknumber(c(-1:1, 51:52, NA))
as_weeknumber("2000-W01")
as_weeknumber(as.Date("2000-12-28"))
```

Make week number object from year and week:

```{r make_weeknumber}
make_weeknumber(2000:2001, 4:5)
make_weeknumber(2019:2020, 53)
```

Get year and week number from an object:

```{r year_week}
x <- as_weeknumber(c(-1:1, 51:52, NA))
year_week(x)
```

Print a tibble:

```{r tibble}
set.seed(0)
library(tibble)
d <- tibble(
  x = seq(as_weeknumber("2000-W01"), as_weeknumber("2000-W09")),
  y = cumsum(rnorm(length(x)))
)
print(d)
```

Plot with week number scale:

```{r plot}
library(ggplot2)
p <- ggplot(d, aes(x, y)) +
  geom_line()
print(p)
```