desc: Description of replicated objects

In DiegoZardetto/EVER: Estimation of Variance by Efficient Replication

Description

Concisely describes a kott.design object.

Usage

desc(deskott, descfun = NULL, ...)

Arguments

deskott	Object of class kott.design containing the replicated survey data.
descfun	Optional description function to be used; must accept a data.frame object as first argument.
...	Additional parameters to be passed to descfun.

Details

This function prints a concise description (i) of the sampling design for the original survey data and (ii) of the replication process these data have undergone.

The optional argument descfun allows to specify an R function (like head, str, summary, ...) to be used to analyse, describe, or summarise the data frame contained in deskott.

Value

The return value depends on the descfun parameter. If not specified (the default option), desc does not return any value.

Author(s)

Diego Zardetto

Examples

data(data.examples)

# Creation of a kott.design object:
kdes<-kottdesign(data=example,ids=~towcod+famcod,strata=~SUPERSTRATUM,
      weights=~weight,nrg=15)

# Concise description:
desc(kdes)

# Display first rows of kdes data:
desc(kdes,head)

# Ask essential information on kdes internal structure:
desc(kdes,str)


# Creation of a kott.cal.design object:
kdescal04p<-kottcalibrate(deskott=kdes,df.population=pop04p,
            calmodel=~x1+x2+x3-1,partition=~regcod,calfun="logit",
            bounds=bounds,aggregate.stage=2)

# Concise description:
desc(kdescal04p)

# Display first rows of kdescal04p data:
desc(kdescal04p,head)

DiegoZardetto/EVER documentation built on April 8, 2021, 1:05 p.m.