checkWCE: Verify that the arguments passed to the WCE function are in...

Description Usage Arguments Details Value Author(s) Examples

View source: R/checkWCE.R

Description

This function checks whether the arguments passed to the WCE function are in the correct format. If at least one argument is incorrectly specified, the function returns an error message specifying what needs to be fixed.

Usage

1
checkWCE(data, id, event, start, stop, expos)

Arguments

data

A data frame in the long (interval) format with one line per unit of time.

id

The name of the variable in data that identifies subjects.

event

The name of the variable in data that identifies the events (must be 0 or 1).

start

The name of the variable in data that identifies the beginning of the interval.

stop

The name of the variable in data that identifies the end of the interval.

expos

The name of the variable in data that represents the exposure of interest.

Details

The arguments passed to WCE must be exactly those passed to WCE.

Value

checkWCE returns a message on the screen indicating whether the arguments are correctly specified or not.

Author(s)

Marie-Pierre Sylvestre
marie-pierre.sylvestre@umontreal.ca

Examples

1
2
checkWCE(drugdata, id = "Id", event = "Event",  start = "Start", stop = "Stop",
 expos = "dose")

Example output

Data are in the right format for WCE estimation.

WCE documentation built on May 2, 2019, 3:35 p.m.

Related to checkWCE in WCE...