Skip to content

Commit

Permalink
Use @inheritParams to simplify documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Moohan committed Aug 1, 2024
1 parent fea33fa commit 663335e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 13 deletions.
14 changes: 2 additions & 12 deletions R/get_latest_resource.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,8 @@
#' * 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}
#' @param rows (optional) specify the max number of rows to return.
#' @param row_filters (optional) a named list or vector that specifies values of
#' columns/fields to keep.
#' e.g. list(Date = 20220216, Sex = "Female").
#' @param col_select (optional) a character vector containing the names of
#' desired columns/fields.
#' e.g. c("Date", "Sex").
#' @param include_context (optional) If `TRUE` additional information about the
#' resource will be added as columns to the data, including the resource ID, the
#' resource name, the creation date and the last modified/updated date.
#' @inheritParams get_dataset
#' @inheritParams get_resource
#'
#' @return a [tibble][tibble::tibble-package] with the data
#' @export
Expand Down
3 changes: 2 additions & 1 deletion man/get_latest_resource.Rd

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

0 comments on commit 663335e

Please sign in to comment.