ds.Surv: Client side function calling 'SurvDS'

Description Usage Arguments Details Value Author(s)

View source: R/dsSurv.R

Description

This function is similar to R function Surv.

Usage

1
2
3
4
5
6
7
8
ds.Surv(
  time = NULL,
  time2 = NULL,
  event = NULL,
  type = NULL,
  newobj = NULL,
  datasources = NULL
)

Arguments

time

a numeric vector indicating the start or follow up time.

time2

a numeric vector indicating the ending time of the interval for interval censored or counting process data only.

event

a numeric vector providing the name of the status indicator(event).Usually binary e.g 0=alive, 1=dead.For multiple endpoint data the event variable will be a factor, whose first level is treated as censoring. Although unusual, the event indicator can be omitted, in which case all subjects are assumed to have an event.

type

character string specifying the type of censoring.Possible values are "right", "left", "counting", "interval", "interval2" or "mstate"..

newobj

a character string specifying the name of the object to which the survival object on the serverside in each study is to be written. If no <newobj> argument is specified, the output object defaults to "Survobj".

datasources

a list of DSConnection-class objects obtained after login. If the datasources argument is not specified the default set of connections will be used: see datashield.connections_default.

Details

This function calculates the survival object usually used as a response variable in the cox proportional hazard model formula..

Value

the results of the survival object stored on the server.

Author(s)

Sofack, Ghislain. (based on corTestDS by Demetris Avraam, for DataSHIELD Development Team)


sofack/dsPackagesClient documentation built on Jan. 17, 2021, 2:18 a.m.