README.Rmd

---
output: github_document
html_preview: true
---
<!--
Copyright 2018 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.
-->

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

```{r setup, echo=FALSE, warning=FALSE}
library(gh)
library(rvest, quietly = TRUE) #web scraping

make_repo_info <- function(repo_name) {
  repo_meta <- get_repo(repo_name)
  repo_link <- paste0("#### [", repo_name, "](", repo_meta$repo$html_url, ")")
  repo_description <- paste0("* ", repo_meta$repo$description)
  badge <- get_badge(repo_meta$readme$message)
#  travis_status <- get_travis_status(repo_name, repo_meta$contents)
  cat(repo_link, repo_description, badge, "\n", sep = "\n")
}

get_repo <- function(repo_name) {
  repo <- gh("/repos/bcgov/:repo", repo = repo_name)
  contents <- gh("/repos/bcgov/:repo/contents/", repo = repo_name)
  readme <- gh("/repos/bcgov/:repo/readme", repo = repo_name,
               .send_headers = c(Accept = "application/vnd.github.VERSION.html"))
  list(repo = repo, contents = contents, readme = readme)           
}

## Get the html of the badge from the readme of a bcgov repo
get_badge <- function(html) {
  html <- read_html(html)
  tagged_badge_node <- tryCatch(rvest::html_node(html, "#user-content-devex-badge"), 
                                error = function(e) NULL)
  if (is.null(tagged_badge_node) || length(tagged_badge_node) == 0) {
    ret <- find_badge(html)
  } else {
    ret <- paste0(gsub("\\n", "", as(tagged_badge_node, "character")), collapse = "")
  }
  paste0("* ", ret)
}

## Find the badge from the 'a' nodes
find_badge <- function(html) {
  a_nodes <- rvest::html_nodes(html, "a")
  node_text <- vapply(a_nodes, function(x) as(x, "character"), FUN.VALUE = character(1))
  badge_nodes <- grep("BCDevExchange.+/(README|projectstates).md", node_text)
  node_text[badge_nodes[1]]
}

# get_travis_status <- function(repo_name, contents) {
#   if (any(vapply(contents, function(x) x$name == ".travis.yml", FUN.VALUE = logical(1)))) {
#     ret <- paste0("* [![Travis-CI Build Status](https://travis-ci.org/bcgov/", 
#                   repo_name, ".svg?branch=master)](https://travis-ci.org/bcgov/",
#                   repo_name, ")")
#   } else {
#     ret <- NULL
#   }
#   ret
# }

```

[![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# Environmental Reporting BC - Repository List
Index of GitHub repositories administered by [Environmental Reporting BC](http://www2.gov.bc.ca/gov/content?id=FF80E0B985F245CEA62808414D78C41B)

Environmental Reporting BC provides access to information about our environment and how it relates to British Columbians. This information comes in the form of indicators that examine the state and trends of different aspects of our environment.

## Indicators

<details><summary><strong>Air</strong></summary>

```{r echo=FALSE, results='asis'}
air_indicators <- c("ozone-caaqs-indicator",
                    "pm25-caaqs-indicator"
)
invisible(lapply(air_indicators, make_repo_info))
```

</details>

<details><summary><strong>Climate Change</strong></summary>

```{r echo=FALSE, results='asis'}
cc_indicators <- c(
  "climate-change-indicators-2015"
)
invisible(lapply(cc_indicators, make_repo_info))
```

</details>

<details><summary><strong>Land & Forests</strong></summary>

```{r echo=FALSE, results='asis'}
land_indicators <- c(
  "land-designations-indicator",
  "protected-lands-and-waters-indicator",
  "roadless-areas-indicator",
  "forest-management-indicators"
)
invisible(lapply(land_indicators, make_repo_info))
```

</details>

<details><summary><strong>Plants & Animals</strong></summary>

```{r echo=FALSE, results='asis'}
pa_indicators <- c(
  "invasive-species-indicator",
  "native-species-rank-indicator",
  "grizzly-bear-status-indicator"
)
invisible(lapply(pa_indicators, make_repo_info))
```

</details>


<details><summary><strong>Sustainability</strong></summary>

```{r echo=FALSE, results='asis'}
susty_indicators <- c("bc-population-indicator",
                      "ghg-emissions-indicator", 
                      "msw-disposal-indicator",
                      "tire-recycling-indicator",
                      "recycling-indicator"
)
invisible(lapply(susty_indicators, make_repo_info))
```

</details>


<details><summary><strong>Water</strong></summary>

```{r echo=FALSE, results='asis'}
water_indicators <- c("groundwater-levels-indicator",
                      "water-quality-analysis"
)
invisible(lapply(water_indicators, make_repo_info))
```

</details>

<!--
```{r echo=FALSE, results='asis'}
indicators <- c("bc-population-indicator",
"climate-change-indicators-2015",
"ghg-emissions-indicator", 
"groundwater-levels-indicator",
"invasive-species-indicator",
"land-designations-indicator",
"msw-disposal-indicator",
"ozone-caaqs-indicator",
"pm25-caaqs-indicator",
"protected-lands-and-waters-indicator",
"tire-recycling-indicator"
)
invisible(lapply(indicators, make_repo_info))
```
-->


## [R](http://www.r-project.org) & [Python](https://www.python.org/) Packages

<details><summary><strong>R</strong></summary>

```{r echo=FALSE, results='asis'}
rpackages <- c("bcdata",
               "bcgovr",
               "bcgroundwater",
               "bcmaps",
               "bcmapsdata",
               "canwqdata", 
               "cccharts",
               "envreportutils",
               "rcaaqs",
               "rems",
               "wqbc",
               "wqindex",
               "ranktrends"
)
invisible(lapply(rpackages, make_repo_info))
```

</details>

<details><summary><strong>Python</strong></summary>

```{r echo=FALSE, results='asis'}
pypackages <- c( 
  "designatedlands"
)
invisible(lapply(pypackages, make_repo_info))
```

</details>

<!--
```{r echo=FALSE, results='asis'}
rpackages <- c( "bcgovr",
"bcgroundwater",
"bcmaps",
"bcmaps.rdata",
"canwqdata", 
"cccharts",
"designatedlands",
"envreportutils",
"rcaaqs",
"rems",
"wqbc",
"wqindex"
)
invisible(lapply(rpackages, make_repo_info))
```
-->

## Supporting & Other Analyses

<details><summary><strong>Interactive Data Visualizations</strong></summary>

```{r echo=FALSE, results='asis'}
int_tools <- c("land-designations-shinyapp")
invisible(lapply(int_tools, make_repo_info))
```

</details>


<details><summary><strong>Supporting Analyses</strong></summary>

```{r echo=FALSE, results='asis'}
analyses <- c(
  "bc-raster-roads"
)
invisible(lapply(analyses, make_repo_info))
```

</details>

<details><summary><strong>Other Stuff</strong></summary>

```{r echo=FALSE, results='asis'}
analyses <- c("envreportbc-snippets"
)
invisible(lapply(analyses, make_repo_info))
```

</details>

## Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an [Issue](https://github.com/bcgov/EnvReportBC/issues).

## How to Contribute

If you would like to contribute, please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines.


## License
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br /><a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.