Merge pull request #33 from nhs-r-community/corrected-checks

Corrected checks

DESCRIPTION

@@ -1,12 +1,15 @@
 Package: NHSRpopulation
-Title: Lower layer Super Output Area (LSOA) population estimates and Indices of Multiple Deprivation (IMD) for England
+Title: Indices of Multiple Deprivation (IMD) for England
 Date: 2021-07-08
 Version: 0.0.2
 Authors@R: c(
-  person("Zoë", "Turner",  email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1033-9158")),
-  person("Milan", "Wiedemann", role = c("aut"), comment = c(ORCID = "0000-0003-1991-282X")),
-  person("Chris", "Beeley", role = c("aut"), comment = c(ORCID = "0000-0003-2344-9962")))
-Description: This package provides Lower layer Super Output Area (LSOA) population estimates and their Indecies of Multiple Deprivation (IMD) for England
+  person("Zoë", "Turner",  email = "[email protected]", 
+  role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1033-9158")),
+  person("Milan", "Wiedemann", role = c("aut"), 
+  comment = c(ORCID = "0000-0003-1991-282X")),
+  person("Chris", "Beeley", role = c("aut"), 
+  comment = c(ORCID = "0000-0003-2344-9962")))
+Description: This package includes functions to retrieve the Indices of Multiple Deprivation (IMD) data from the ONS by LSOA, currently for England.
 License: MIT + file LICENSE
 URL: https://nhs-r-community.github.io/NHSRpopulation/
 BugReports: https://github.com/nhs-r-community/NHSRpopulation/issues
@@ -18,6 +21,8 @@ Imports:
     cli,
     dplyr,
     ggplot2,
+    httr,
+    jsonlite,
     magrittr,
     NHSRpostcodetools,
     patchwork,
@@ -29,7 +34,8 @@ Suggests:
     knitr,
     testthat (>= 3.0.0),
     purrr,
-    tibble
+    tibble,
+    PostcodesioR
 Remotes: nhs-r-community/NHSRpostcodetools
 VignetteBuilder: knitr
 Config/testthat/edition: 3

R/helpers.R

@@ -93,6 +93,8 @@ get_count <- function(response_list) {
 
 #' Send a GET request to the API
 #'
+#' @param query_params uses the output from the function `set_country_params()`
+#'
 #' @return list
 #' @export
 #'
@@ -104,7 +106,8 @@ get_api <- function(query_params) {
 
 #' Parse the JSON response
 #'
-#' @return
+#' @param json uses output from function `get_api()`
+#'
 #' @export
 #'
 parse_json <- function(json) {
@@ -114,6 +117,8 @@ parse_json <- function(json) {
 
 #' Create a data frame
 #'
+#' @param response_list uses output from the function `parse_json()`
+#'
 #' @return data frame
 #' @export
 #'

R/imd.R

@@ -9,18 +9,6 @@
 #' @param fix_invalid Boolean, default `TRUE`. Whether to try to fix any
 #'  postcodes that are not found (potentially because they are terminated codes,
 #'  or contain typos).
-#' @param country select which country in the nations the IMD scores relate to.
-#' Note that datasets cannot be mixed.
-#' Deciles are generated from the data provided from the API and so are based
-#' on the totals.
-#'
-#' @examples
-#' postcodes <- c("HD1 2UT", "HD1 2UU", "HD1 2UV")
-#' test_df1 <- dplyr::tibble(
-#'   place = paste0("place_", 1:3),
-#'   postcode = postcodes
-#' )
-#' postcode_data_join(test_df1, fix_invalid = TRUE)
 #' @export
 get_imd <- function(
     .data,

README.Rmd

@@ -35,7 +35,7 @@ To find out more about the functions there is a vignette for [Getting Started](h
 
 ## Sources of Data
 
-The original source of the data provided in this R package is available [here](https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/lowersuperoutputareamidyearpopulationestimates) and licenced under the [Open Government Licence v3.0](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
+The original source of the data provided in this R package is available from the [ONS](https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/lowersuperoutputareamidyearpopulationestimates) and licenced under the [Open Government Licence v3.0](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
 
 
 ## Code of Conduct

README.md

@@ -38,7 +38,8 @@ areas only and not with England see this
 ## Sources of Data
 
 The original source of the data provided in this R package is available
-[here](https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/lowersuperoutputareamidyearpopulationestimates)
+from the
+[ONS](https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/lowersuperoutputareamidyearpopulationestimates)
 and licenced under the [Open Government Licence
 v3.0](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).