uklakes

Repo for uklakes R package, which allows access to data on UK CEH Lakes portal

https://github.com/robbriers/uklakes

Repository

Repo for uklakes R package, which allows access to data on UK CEH Lakes portal

README.Rmd

---
output: github_document
---



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

# uklakes 


[![R-CMD-check](https://github.com/robbriers/uklakes/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/robbriers/uklakes/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/robbriers/uklakes/graph/badge.svg)](https://app.codecov.io/gh/robbriers/uklakes)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![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)
[![pkgcheck](https://github.com/robbriers/uklakes/workflows/pkgcheck/badge.svg)](https://github.com/robbriers/uklakes/actions?query=workflow%3Apkgcheck)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15092617.svg)](https://doi.org/10.5281/zenodo.15092617)


The [UK CEH Lake Portal](https://uklakes.ceh.ac.uk/) is a GIS-based inventory 
of information about more than 40000 lakes across the UK. The information 
available for each lake varies, but includes basic physical description, 
typology and other information.

The `uklakes` package allows you to retrieve a summary of the lake information 
for a lake or series of lakes, based on the lake wbid (waterbody id) number. 
It does this by responsibly webscraping the information (using the [polite package](https://cran.r-project.org/package=polite)) from the webpage of each 
lake as the website does not provide an API or any easy way to extract the data
returned. You can also search for lake wbid values based on strings in the lake 
name to determine the wbids to search for.

Information on the general physical characteristics, typology, chemistry and 
connectivity metrics are retrieved. Biology, Land cover and water quality 
information are not. For details of the information available, see the 
[UK Lakes Portal Website](https://uklakes.ceh.ac.uk/), or the [output reference list](https://robbriers.github.io/uklakes/articles/uklakes_output_ref.html).

Use of the package implies acceptance of the Terms of Use available [here](https://www.ceh.ac.uk/terms-of-use).

## Installation

You can install the current version of uklakes from 
[GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("robbriers/uklakes")
```

## Details of use

See the [Get started](https://robbriers.github.io/uklakes/articles/uklakes.html) vignette for how to use the package.

## Code of Conduct
  
Please note that the `uklakes` package is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.

Owner

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "uklakes",
  "description": "Retrieves a summary of the lake information from the UK CEH Lake Portal for a lake or series of lakes, based on the lakeid. Can also search for lakeid values based on strings in the lake name. For details of the information available, see the Lakes Portal Website (\\urlhttps://uklakes.ceh.ac.uk/.)",
  "name": "uklakes: Retrieves Lake Information from UK CEH Lakes Portal",
  "codeRepository": "https://github.com/robbriers/uklakes",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.2.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Rob",
      "familyName": "Briers",
      "email": "r.briers@napier.ac.uk",
      "@id": "https://orcid.org/0000-0003-0341-1203"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Rob",
      "familyName": "Briers",
      "email": "r.briers@napier.ac.uk",
      "@id": "https://orcid.org/0000-0003-0341-1203"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "polite",
      "name": "polite"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "rnrfa",
      "name": "rnrfa"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "rvest",
      "name": "rvest"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "tidyr",
      "name": "tidyr"
    },
    "SystemRequirements": null
  },
  "fileSize": "264.001KB",
  "relatedLink": "https://robbriers.github.io/uklakes/",
  "readme": "https://github.com/robbriers/uklakes/blob/main/README.md",
  "contIntegration": [
    "https://github.com/robbriers/uklakes/actions/workflows/R-CMD-check.yaml",
    "https://app.codecov.io/gh/robbriers/uklakes"
  ],
  "developmentStatus": [
    "https://lifecycle.r-lib.org/articles/stages.html#stable",
    "https://www.repostatus.org/#active"
  ]
}

GitHub Events