README.Rmd

---
output: github_document
always_allow_html: yes
---

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

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
htmltools::tagList(rmarkdown::html_dependency_font_awesome())
```

# gcalendr <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![R build status](https://github.com/andrie/gcalendr/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/gcalendr/actions)
[![Travis build status](https://travis-ci.org/andrie/gcalendr.svg?branch=master)](https://travis-ci.org/andrie/gcalendr)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/gcalendr)](https://cran.r-project.org/package=gcalendr)
[![Codecov test coverage](https://codecov.io/gh/andrie/gcalendr/branch/master/graph/badge.svg)](https://codecov.io/gh/andrie/gcalendr?branch=master)
<!-- badges: end -->


This package enables you to read events from google calendar.

## Installation

The package is not yet on CRAN.

You can install the development version of `gcalendr` from github using:

```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("andrie/gcalendr")
```


## Example

Use this example to authenticate, list available calendars and view events:

```{r eval=FALSE}
library(gcalendr)

## Set up google oauth permissions
## This will prompt you to specify an account
calendar_auth()

```


```{r eval=FALSE}
## To specify a specific account, provide your account id, typically an email address
calendar_auth("apdevries@gmail.com")

## Retrieve tibble of available calenders
calendar_ids <- calendar_list()
calendar_ids

## Retrieve tibble of events from a specific calendar

my_cal_id <- "apdevries@gmail.com"
events <- calendar_events(my_cal_id, days_in_past = 90, days_in_future = 90)
events
```