Skip to content

Commit

Permalink
Fix some typos and format the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Moohan committed Jul 4, 2024
1 parent b275ec7 commit 1f630b5
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 28 deletions.
5 changes: 3 additions & 2 deletions R/get_dataset_additional_info.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#' get a datasets additional info
#'
#' `get_dataset_additional_info()`returns a list of dataset names alongwith additional information,
#' such as the amount of resources and the date it was last updated
#' `get_dataset_additional_info()` returns a list of dataset names along with
#' additional information, such as the amount of resources and the date it was
#' last updated.
#'
#' @inheritParams get_dataset
#'
Expand Down
16 changes: 8 additions & 8 deletions R/get_latest_resource.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
#' For these it is useful to be able to retrieve the latest
#' resource. These data sets include:
#'
#' gp-practice-populations
#' gp-practice-contact-details-and-list-size
#' nhsscotland-payments-to-general-practice,
#' dental-practices-and-patient-registrations,
#' general-practitioner-contact-details,
#' prescribed-dispensed,
#' prescriptions-in-the-community,
#' community-pharmacy-contractor-activity
#' * gp-practice-populations
#' * gp-practice-contact-details-and-list-size
#' * nhsscotland-payments-to-general-practice,
#' * dental-practices-and-patient-registrations,
#' * general-practitioner-contact-details,
#' * prescribed-dispensed,
#' * prescriptions-in-the-community,
#' * community-pharmacy-contractor-activity
#'
#' @param dataset_name name of the dataset as found on
#' \href{https://www.opendata.nhs.scot/}{NHS Open Data platform}
Expand Down
8 changes: 3 additions & 5 deletions R/get_latest_resource_id.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,17 @@
#' two conditions have to be met. It has to appear at the top of
#' of the resource list as shown on the open data platform.
#' The order they are returned via the api is the same
#' as they appear on the open data platfrom. It also
#' as they appear on the open data platform. It also
#' has to have the most recent date created
#'
#' There are only some datasets that this functionality
#' is relevent to, these are listed within applicable
#' is relevant to, these are listed within applicable
#' datasets and are the datasets that keep historic
#' resources instead of over writting them
#' resources instead of over writing them
#'
#' @inheritParams get_dataset
#'
#' @return a [string] with the resource id
#'

get_latest_resource_id <- function(dataset_name) {
applicable_datasets <- c(
"gp-practice-populations", "gp-practice-contact-details-and-list-sizes",
Expand Down
5 changes: 3 additions & 2 deletions man/get_dataset_additional_info.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 10 additions & 8 deletions man/get_latest_resource.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/get_latest_resource_id.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1f630b5

Please sign in to comment.