Skip to content

Commit

Permalink
add repostatus badge and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andypicke committed May 14, 2024
1 parent ff8da62 commit 230c9f3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
7 changes: 4 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ knitr::opts_chunk$set(
# emberr

<!-- badges: start -->

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![R-CMD-check](https://github.com/andypicke/emberr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andypicke/emberr/actions/workflows/R-CMD-check.yaml)

[![Project Status: WIP](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
<!-- badges: end -->

The goal of emberr is to provide functions to query and retrieve data from the [Ember](https://ember-climate.org/) [API](https://ember-climate.org/data/api/).
Expand All @@ -30,9 +29,11 @@ You can view the [API documentation](https://api.ember-climate.org/docs) for det
1) Ember is cited as the data source. E.g. 'Monthly electricity generation data, Ember'
2) You may not add any additional legal/technological restrictions to the data.*

See this [blog post](https://andypicke.quarto.pub/portfolio/posts/emberr/emberr.html) for a description and examples of the package.

## Installation

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

``` r
# install.packages("devtools")
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/andypicke/emberr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andypicke/emberr/actions/workflows/R-CMD-check.yaml)

[![Project Status:
WIP](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
<!-- badges: end -->

The goal of emberr is to provide functions to query and retrieve data
Expand All @@ -27,9 +28,14 @@ requirements by this license are that:
2) You may not add any additional legal/technological restrictions to
the data.\*

See this [blog
post](https://andypicke.quarto.pub/portfolio/posts/emberr/emberr.html)
for a description and examples of the package.

## Installation

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

``` r
Expand All @@ -51,7 +57,6 @@ returns data for all countries/regions (“entities”).
library(emberr)

gen <- emberr::get_ember_data(dataset = "electricity-generation", temporal_resolution = "monthly", min_date = 2021, max_date = 2023)
#> No encoding supplied: defaulting to UTF-8.

head(gen)
#> entity entity_code is_aggregate_entity date series
Expand Down Expand Up @@ -86,7 +91,6 @@ Retrieve data for just one country/region:
``` r

df_usa <- emberr::get_ember_data(entity = "United States")
#> No encoding supplied: defaulting to UTF-8.

str(df_usa)
#> 'data.frame': 153 obs. of 8 variables:
Expand All @@ -105,7 +109,6 @@ You can also retrieve data for multiple countries/regions:
``` r

df <- get_ember_data(min_date = 2020, entity = "United States,United Kingdom")
#> No encoding supplied: defaulting to UTF-8.
str(df)
#> 'data.frame': 132 obs. of 8 variables:
#> $ entity : chr "United Kingdom" "United Kingdom" "United Kingdom" "United Kingdom" ...
Expand Down

0 comments on commit 230c9f3

Please sign in to comment.