vulnerability_index: Vulnerability Index

Description Usage Arguments Value See Also

View source: R/vulnerability_index.R

Description

It allows the observations to be ordered by different methods (default percentile rank), and in consideration of domains grouping indicators.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
vulnerability_index(
  data,
  direct = NULL,
  inverse = NULL,
  table = NULL,
  weighted = TRUE,
  domains = "default",
  level = NULL,
  ordered = TRUE,
  method = "percent_rank",
  na.rm = FALSE
)

Arguments

data

A dataframe containing the variables that will be analyzed.

direct

A vector indicating the name of the variables that contribute directly to the vulnerability index.

inverse

A vector indicating the name of the variables that contribute inversely to the vulnerability index.

table

A dataframe indicating the variables "codename", "Direccion", "Dominio" and "Escala_Geografica" as a minimum. If this argument is specified, it is no longer necessary to specify the direct and inverse arguments.

weighted

A logical value indicating whether the "Dominio" information is used for the index calculation.

domains

A vector indicating the names of the domains grouping the variables of interest. If the argument "table" containing the variable "Dominio" is used, only "default" is indicated in this argument.

level

A vector indicating the level of analysis. It currently supports 3 values:"departamental", "provincial", and "distrital".

ordered

A logical value indicating whether the cases analyzed will be ordered from highest to lowest.

method

A vector indicating the analysis method used for the index. Currently only "percent_rank" is supported.

na.rm

A logical value indicating whether cases where missing values are eliminated.

Value

A [tibble::tibble()] containing the variables analyzed by the function.

See Also

[dplyr::percent_rank()].


botbarja/test_list documentation built on Dec. 19, 2021, 10:49 a.m.