states: Create an Object for the States of Nigeria

In naijR: Operations to Ease Data Analyses Specific to Nigeria

Create an Object for the States of Nigeria

Description

Create an Object for the States of Nigeria

Print regions

Return the First or Last Parts of a Region Object

Usage

states(states, gpz = NULL, all = TRUE, warn = TRUE)

## S3 method for class 'regions'
print(x, ...)

## S3 method for class 'regions'
head(x, ...)

## S3 method for class 'regions'
tail(x, ...)

Arguments

states	A character vector with strings representing one or more States of Nigeria. If missing, the function will return a states all the States, with or without the Federal Capital Territory (FCT).
gpz	NULL (the default) or, case insensitively, one or more of the following strings: "nc", "ne", "nw", "se", "ss" and "sw" (see "Details").
all	logical; whether to include the FCT in the result.
warn	logical; issue a warning when one or more elements are not actually States (i.e. they were misspelt).
x	The object of class region
...	Arguments to tail.default

Details

gpz represents a geopolitical zone which, in the Nigerian context, is a national subdivision that groups contiguous states that bear certain socio-cultural and political similarities. Historically, they arise from sub-national administrative divisions known as 'Regions' that existed at the time of the country's independence. There are at present 6 such zones - North-Central, North-East, North-West, South-East,South-South and South-West.

Value

The States of Nigeria as a whole or by zones, as an S3 object of class states.

Examples

states()  # lists names of all States
states(gpz = "se")  # lists States in South-East zone

naijR documentation built on Aug. 8, 2023, 5:13 p.m.