as.data.frame.prevR: Convert an object of class prevR into a data.frame.

In larmarange/prevR: Estimating Regional Trends of a Prevalence from a DHS and Similar Surveys

Convert an object of class prevR into a data.frame.

Description

This function merges the slots clusters et rings of a object of class prevR.

Usage

## S3 method for class 'prevR'
as.data.frame(x, ..., N = NULL, R = NULL, clusters.only = FALSE)

Arguments

x	object of class prevR.
...	not used, for compatibility with the generic method base::as.data.frame().
N	integer or list of integers setting elements of rings to extract.
R	integer or list of integers setting elements of rings to extract.
clusters.only	return only the slot clusters of x?

Value

If clusters.only = TRUE, the function will return only the slot clusters of x.

Otherwise, slots clusters and rings of x will be merged in a unique data frame. The columns of rings will be renamed adding a suffix like .N300.RInf.

N and R define the elements of rings to extract. If not specified (NULL), all the elements of rings will be included.

See Also

base::as.data.frame(), prevR.

Examples

str(fdhs)
str(as.data.frame(fdhs))
## Not run: 
r.fdhs <- rings(fdhs, N = c(100, 200, 300))
str(r.fdhs)
str(as.data.frame(r.fdhs, clusters.only = TRUE))
str(as.data.frame(r.fdhs))
str(as.data.frame(r.fdhs, N = 300))

## End(Not run)

larmarange/prevR documentation built on May 18, 2023, 3:50 a.m.