Skip to content

fix lost braces and fix another documentation issue at regions #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cstawitz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix lost braces and fix another documentation issue at regions #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 39 additions & 39 deletions R/assertions.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,55 +4,56 @@
#' @param values_var The variable that contains the upstream data to be
#' imputed to the downstream data, defaults to \code{"values"}.
#' @param geo_var The variable that contains the geographical codes in the
#' NUTS typologies, defaults to code{"geo_var".}
#' NUTS typologies, defaults to \code{"geo_var".}
#' @param method_var The variable that contains the metadata on various
#' processing information, defaults to \code{NULL} in which case it will
#' be returned as \code{'method'}.
#' @param nuts_year The year of the NUTS typology to use.
#' @return A logical variable showing if all assertions were met.
#' @keywords internal

validate_data_frame <- function(dat,
geo_var = NULL,
nuts_year = NULL,
values_var = NULL,
method_var = NULL) {

validate_data_frame <- function(
dat,
geo_var = NULL,
nuts_year = NULL,
values_var = NULL,
method_var = NULL
) {
assertthat::assert_that(
"data.frame" %in% class(dat),
"data.frame" %in% class(dat),
msg = "The parameter 'dat' must be a data.frame-like object, like a data frame or a tibble."
)
assertthat::assert_that (
nrow(dat) > 0,

assertthat::assert_that(
nrow(dat) > 0,
msg = "The data frame has no observations."
)

if (!is.null(geo_var)) {
assertthat::assert_that(
geo_var %in% names(dat),
msg = glue::glue ("geo_var={geo_var} is not among names(dat)")
geo_var %in% names(dat),
msg = glue::glue("geo_var={geo_var} is not among names(dat)")
)
}

if (!is.null(values_var)) {
assertthat::assert_that(
values_var %in% names(dat),
msg = glue::glue ("values_var={values_var} is not among names(dat)")
values_var %in% names(dat),
msg = glue::glue("values_var={values_var} is not among names(dat)")
)
}

if (!is.null(method_var)) {
assertthat::assert_that(
method_var %in% names(dat),
msg = glue::glue ("method_var={method_var} is not among names(dat)")
method_var %in% names(dat),
msg = glue::glue("method_var={method_var} is not among names(dat)")
)
}

if (!is.null(nuts_year)) {
assertthat::assert_that(
nuts_year %in% c(1999, 2003, 2006, 2010, 2013, 2016, 2021),
msg = glue::glue ("nuts_year={nuts_year} is an invalid parameter setting.")
msg = glue::glue("nuts_year={nuts_year} is an invalid parameter setting.")
)
}
}
Expand Down Expand Up @@ -81,44 +82,43 @@ validate_data_frame <- function(dat,
#' @return A boolean, logical variable if the parameter calls are valid.
#' @export

validate_parameters <- function(typology = NULL,
param = NULL,
param_name = NULL) {

validate_parameters <- function(
typology = NULL,
param = NULL,
param_name = NULL
) {
## First make assertions about a mandatory parameter -----------------------
if (!is.null(param_name)) validate_param ( param = param,
param_name = param_name )

if (!is.null(param_name)) {
validate_param(param = param, param_name = param_name)
}

## Then make assertions about optional parameters --------------------------
if (!is.null(typology)) validate_typology(typology)
}

#' Validate Mandatory Parameters
#'
#' These parameters must not be \code{NULL}. The \code{param_name} is needed for a
#'
#' These parameters must not be \code{NULL}. The \code{param_name} is needed for a
#' meaningful error message.
#'
#' @inheritParams validate_parameters
#' @return A boolean, logical variable if the mandatory parameter is present.
#' @keywords internal
validate_param <- function (param, param_name ) {

validate_param <- function(param, param_name) {
assertthat::assert_that(
! is.null(param),
msg = glue::glue("The parameter '{param_name}' must not be NULL.")
!is.null(param),
msg = glue::glue("The parameter '{param_name}' must not be NULL.")
)

}

#' Validate typology Parameter
#'
#'
#' @inheritParams validate_parameters
#' @return A boolean, logical variable if the typology in question exists, the typology parameter is valid.
#' @keywords internal
validate_typology <- function (typology) {
validate_typology <- function(typology) {
assertthat::assert_that(
typology %in% c("NUTS", "NUTS1", "NUTS2", "NUTS3", "NUTS0"),
msg = "Currently only NUTS-like typologies are supported, i.e., NUTS, NUTS0, NUTS1, NUTS2, NUTS3."
)
}

Loading