Help for package ismtchile

Type:

Package

Title:

Calculating Socio Material Territorial Index

Version:

2.1.5

Description:

Paquete creado con el fin de facilitar el cálculo y distribución del índice Socio Material Territorial (ISMT), elaborado por el Observatorio de Ciudades UC. La metodología completa está disponible en "ISMT" (https://ideocuc-ocuc.hub.arcgis.com/datasets/6ed956450cfc4293b7d90df3ce3474e4/about) [Observatorio de Ciudades UC (2019)]. || Package created to facilitate the calculation and distribution of the Socio-Material Territorial Index by Observatorio de Ciudades UC. The full methodology is available at "ISMT" (https://ideocuc-ocuc.hub.arcgis.com/datasets/6ed956450cfc4293b7d90df3ce3474e4/about) [Observatorio de Ciudades UC (2019)].

License:

MIT + file LICENSE

Encoding:

UTF-8

LazyData:

true

RoxygenNote:

7.2.3

Imports:

stringr, dplyr

Language:

es-CL

Depends:

R (≥ 4.2.0)

NeedsCompilation:

Packaged:

2023-07-03 19:09:57 UTC; mrosas

Author:

Martín Rosas Araya [aut, cre, cph]

Maintainer:

Martín Rosas Araya <mrosas1690@gmail.com>

Repository:

CRAN

Date/Publication:

2023-07-05 14:30:05 UTC

Datos de ejemplo, censo 2017 || || Example data, 2017 census (Chile)

Description

Data de ejemplo proveniente del censo 2017. Corresponde a la comuna de San Pablo, X Región de Los Lagos. Se eligió por su pequeño tamaño, adecuado para límites de tamaño de archivo de CRAN y GitHub. Obtenido de la página oficial del INE y filtrado por comuna. || || Example data from 2017 Chilean census. It is the data from San Pablo commune. It was chosen because of its small size, appropriate for CRAN and GitHub file size limitations. Obtained from INE's official website and filtered by commune.

Usage

c17_example

Format

## 'c17_example' A data frame with 7512 rows and 60 columns:

region: ID de la región || Region ID
provincia: ID de la provincia || Province ID
comuna: ID de la comuna || Commune ID
dc: ID del distrito || District ID
area: ID del área || Area ID
zc_loc: Zona local || Local zone
id_zc_loc: ID de zona local || Local zone ID
nviv: Número de la vivienda || Dwelling number
p01 - p16a: Preguntas del censo || Census questions

Limpieza de la base de datos censal – Census database cleanup

Description

Limpia la base de datos de forma de normalizar los nombres de los campos y reducir la cantidad de variables, facilitando así la ejecución de las funciones que siguen en el flujo de cálculo. || || Cleans the database, normalizing the field names and reducing the number of variables, facilitiating the execution of the following functions down the workflow.

Usage

cleanup(
  df,
  year = 2017,
  vars.as.factors = FALSE,
  level = "zc",
  tipo_viv = "tipoviv",
  ocupacion = "ocup_viv",
  parentesco = "parentesco",
  dormitorios = "ndorms",
  muro = "mat_muro",
  techo = "mat_techo",
  piso = "mat_piso"
)

Arguments

df

objeto data.frame. Se recomienda usar la base original del Censo 2017, disponible a través de load_data(). || || data.frame object; recommendation is to use the original 2017 census database, available through load_data().

year

integer. Default es 2017. || || integer. Default is 2017.

vars.as.factors

boolean. Si las variables están como factores (como en las bases censales originales), cambiar a TRUE. Default es FALSE, ya que se asume que la base pasá por la función literalize(). || || boolean. If variables are as factors (like in the original census databases), change to TRUE. Default is FALSE, as it is assumed the database has been through the literalize() function.

level

string. Nivel de agrupación de los datos finales. Acepta valores zc (zona censal) y mzn (manzana). El nivel de manzana no está disponible para el 2017 debido al secreto estadístico de la base de datos de origen. Default es zc. || || string. Grouping level for the final data. Values zc (census zone) and mzn (block). Block level is not available for 2017 due to statistical secret of original database. Default is zc.

tipo_viv

string. Nombre del campo de tipo de vivienda. Default es tipoviv. || || string. Name of the dwelling type field. Default is tipoviv.

ocupacion

string. Nombre del campo de ocupación de la vivienda. Default es ocup_viv. || || string. Name of the home occupation field. Default is ocup_viv.

parentesco

string. Nombre del campo de parentesco. Default es parentesco. || || string. Name of the familial relationship field. Default is parentesco.

dormitorios

string. Nombre del campo con el número de dormitorios del hogar. Default es ndorms. || || string. Name of the number of bedrooms field. Default is ndorms.

muro

string. Nombre del campo de condición del muro. Default es mat_muro. || || string. Name of the wall condition field. Default is mat_muro.

techo

string. Nombre del campo de condición del techo. Default es mat_techo. || || string. Name of the ceiling condition field. Default is mat_techo.

piso

string. Nombre del campo de condición del suelo. Default es mat_piso. || || string. Name of the floor condition field. Default is mat_piso.

Value

objeto data.frame conteniendo solo las variables necesarias para los cálculos siguientes. || || data.frame object containing only the variables that are necessary for the following calculations.

Examples

 data(c17_example)
 clean <- c17_example |> literalize(2017) |> cleanup()

Cálculo de ISMT completo a partir del Censo 2017 – Full ISMT calculation from 2017 Census.

Description

Ejecuta el cálculo completo del ISMT. Agrupa las funciones 'literalize()', 'geofilter()', 'cleanup()', 'precalc()', 'get_pca()' e 'ismt_scores()'. La tabla obtenida debería ser idéntica al resultado de concatenar estas funciones una a una.

Usage

full_ismt(
  df,
  r,
  ur,
  rfield = "id_region",
  urfield = "tipo_area",
  year = 2017,
  tipo_vivienda = "tipoviv",
  ocupacion = "ocup_viv",
  ndorms = "ndorms",
  parentesco = "parentesco",
  muro = "mat_muro",
  techo = "mat_techo",
  piso = "mat_piso",
  grouping = "id_zona",
  level = "zc"
)

Arguments

df

objeto data.frame. Default es 2017. || || data.frame object. Default is 2017.

r

integer. Se aceptan valores entre 1 y 16 para Chile 2017. Si r == 99, no se define una región en particular y se trabaja con valores a nivel nacional. || || integer. Values between 1 and 16 are acceptable for Chile 2017. If r == 99, no region will be defined and work will continue with national level values.

ur

integer. Valores aceptables son 1 y 2. Define si se requiere zona urbana ur = 1 o rural ur = 2. || || integer. Accepted values are 1 and 2. Defines whether urban ur = 1 or rural ur = 2 data is requested.

rfield

string. Nombre del campo que corresponde al número de la región. Default es region. || || string. Name of the field corresponding to the region number. Default is region.

urfield

string. Nombre del campo que define el tipo de área (urbana o rural). Default es tipo_area. || || string Name of the field corresponding to the desired area (urban or rural). Default is tipo_area.

year

integer. Default es 2017. || || integer. Default is 2017.

tipo_vivienda

string. Nombre del campo de tipo de vivienda. Default es tipoviv. || || string. Name of the dwelling type field. Default is tipoviv.

ocupacion

string. Nombre del campo de ocupación de la vivienda. Default es ocup_viv. || || string. Name of the home occupation field. Default is ocup_viv.

ndorms

string. Nombre del campo con el número de dormitorios del hogar. Default es ndorms. || || string. Name of the number of bedrooms field. Default is ndorms.

parentesco

string. Nombre del campo de parentesco. Default es parentesco. || || string. Name of the familial relationship field. Default is parentesco.

muro

string. Nombre del campo de condición del muro. Default es mat_muro. || || string. Name of the wall condition field. Default is mat_muro.

techo

string. Nombre del campo de condición del techo. Default es mat_techo. || || string. Name of the ceiling condition field. Default is mat_techo.

piso

string. Nombre del campo de condición del suelo. Default es mat_piso. || || string. Name of the floor condition field. Default is mat_piso.

grouping

string. Nombre del campo con la variable de la unidad espacial agrupadora. Default es id_zona. || || string. Name of the field with the spacial grouping unit variable. Default is id_zona.

level

Value

objeto data.frame conteniendo el cálculo completo del ISMT.

Examples

 
   data(c17_example)
   ismt <- full_ismt(c17_example, 10, 1)

Calcular análisis de componentes principales – Calculate Principal Components Analysis

Description

Cálculo de análisis de componentes principales en base a las 4 vatriables principales del ISMT. La función asume que la base de datos ha pasado por precalc(), ya que requiere los puntajes normalizados por variable. || || Calculation of principal components analysis based on the 4 main variables of ISMT. Assumes the database has been through precalc(), as it rqeuires the normalized scores by variable.

Usage

get_pca(
  df,
  esc = "ptje_esc",
  hacin = "ptje_hacin",
  mat = "ptje_mater",
  alleg = "ptje_alleg"
)

Arguments

df

objeto data.frame con la informaión de puntajes normalizados. || || data.frame object with the normalized scores.

esc

string. Nombre de la variable con el puntaje de escolaridad del jefe de hogar. Default is ptje_esc || || string. Name of the field with the scholarship score for the home head. Default is ptje_esc.

hacin

string. Nombre del campo con el puntaje de hacinamiento. Default es ptje_hacin. || || string. Name of the field with the overcrowding score. Default is ptje_hacin.

mat

string. Nombre del campo con el puntaje de materialidad de la vivienda. Default es ptje_mater. || || string. Name of the field with the dwelling material score. Default is ptje_mater.

alleg

string. Nombre del campo con el puntaje de allegamiento. Default is ptje_alleg. || || string. Name of the field with the relative crowding score. Default is ptje_alleg.

Value

objeto data.frame con el cálculo de componentes principales. || || data.frame object with the principal components analysis calculation.

Examples

 data(c17_example)
 clean <- c17_example |> literalize(2017) |> cleanup() |> precalc() |> get_pca()

Cálculos finales de ISMT – ISMT final calculations

Description

Ejecuta los cálculos finales de ISMT. Define los grupos socioeconómicos por unidad territorial y los cuantifica en varias categorías. || || Executes the final ISMT calculations. Defines the socio-economic groups and quantifies them in several categories.

Usage

ismt_scores(df, r, ismt_score = "ismt_pn", grouping = "geocode")

Arguments

df

objeto data.frame. Asume que la base de datos ha pasado por cleanup(), precalc(), y get_pca(). || || data.frame object. Assumes the database has been through cleanup(), precalc(), and get_pca().

r

integer. Número de la región de trabajo. Acepta valores entre 1 y 16; si r = 99, se utilizan valores a nivel nacional. || || integer. Number of the working region. Accepts values between 1 and 16; if r = 99, national-level values will be used.

ismt_score

string. Nombre del campo del puntaje ISMT, calculado desde get_pca(). Default es ismt_pn. || || string. Name of the ISMT sscore field, as calculated from get_pca()]. Default is ismt_pn.

grouping

string. Nombre del campo con la variable de la unidad espacial agrupadora. Default es geocode. || || string. Name of the field with the spacial grouping unit variable. Default is geocode.

Value

objeto data.frame agrupado por la unidad espacial especificada con información de ISMT. || || data.frame object grouped by the specified spatial unit with ISMT information.

Examples

 data(c17_example)
 clean <- c17_example |> literalize(2017) |> cleanup() |> precalc() |> get_pca() |> ismt_scores(10)

Literalizar bases censales – Literalize census databases

Description

Literalizar bases censales – Literalize census databases

Usage

literalize(df, year)

Arguments

df

objeto data.frame correspondiente a la base de datos original de los censos 2017, 2012, 2002, 1992 o 1982. – data.frame object corresponding to the original database for the 2017, 2012, 2002, 1992 or 1982 census.

year

integer. No provee Default para forzar la explicitación del año de la base. || || integer. Default is not provided, so as to force explicitation of the database's year.

Value

objeto data.frame con las variables como texto en lugar de factores (nombres y categorías homologados para todos los censos)

Examples

 data(c17_example)
 clean <- c17_example |> literalize(2017)

Asignar nombres de divisones geográficas

Description

Asigna nombres de divisones geográficas en base a una variable de referencia.

Usage

namify(df, common_var, level)

Arguments

df

objeto data.frame.

common_var

Nombre de la variable con el código común a utilizar.

level

Nivel de la variable de referencia: r para región, p para provincia, c para comuna y zc para zona censal.

Value

df con nombres de divisiones geográficas

Examples

 
   data(c17_example)
   ismt <- full_ismt(c17_example, 10, 1) |> namify('ine17', 'c')

Precálculos ISMT – ISMT Precalculations

Description

Ejecuta precálculos necesarios para el resto del proceso del ISMT. || || Executes precalculations necessary for the rest of the ISMT process.

Usage

precalc(
  df,
  hacin = "ind_hacinam",
  alleg = "n_hog_alleg",
  esc = "a_esc_cont",
  mat = "ind_mater"
)

Arguments

df

objecto data.frame. Asume que la base de datos ha pasado por cleanup(). || || data.frame object. Assumes the database has been through cleanup().

hacin

string. Nombre del campo del indicador de hacinamiento. Default es ind_hacinam. || || string. Name of the field with the overcrowding score. Default is ind_hacinam.

alleg

string. Nombre del campo del indicador de allegamiento. Default es n_hog_alleg. || || string. Name of the field with the relative crowding score. Default is n_hog_alleg.

esc

string. Nombre del campo del indicador de escolaridad del jefe de hogar. Default es a_esc_cont. || || string. Name of the field with the scholarship of the home head score. Default is a_esc_cont.

mat

string. Nombre del campo del indicador de materialidad de la vivienda. Default es ind_mater. || || string. Name of the field with the dwelling material score. Default is ind_mater.

Value

objeto data.frame con los precálculos necesarios para calcular el ISMT. || || data.frame object with the necessary precalculations to calculate ISMT.

Examples

 data(c17_example)
 clean <- c17_example |> literalize(2017) |> cleanup() |> precalc()