ds.coxphSummary: Returns a summary of a server-side Cox proportional hazards...

In neelsoumya/dsSurvivalClient: dsSurvival: Privacy preserving survival models for federated individual patient meta-analysis in DataSHIELD

Returns a summary of a server-side Cox proportional hazards model

Description

This function returns a summary of server-side for a Cox proportional hazards model.

Usage

ds.coxphSummary(x = NULL, datasources = NULL)

Arguments

x	character string (potentially including * symbol without spaces) specifying the name of the fitted server-side Cox proportioanl hazards model that has been created using ds.coxphSLMAassign()
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. For more information see Details.

Details

This is a function that returns a summary of a fitted Cox proportional hazards model.

Server function called: coxphSummaryDS.

Value

coxphSummaryDS returns to the client-side the summary of the Cox proportional hazards model

Author(s)

Soumya Banerjee and Tom RP Bishop, 2021

Examples

## Not run: 

  ## Version 1.0.0
  
  # connecting to the Opal servers

  require('DSI')
  require('DSOpal')
  require('dsBaseClient')

  builder <- DSI::newDSLoginBuilder()
  builder$append(server = "study1", 
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "SURVIVAL.EXPAND_NO_MISSING1", driver = "OpalDriver")
  builder$append(server = "study2", 
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "SURVIVAL.EXPAND_NO_MISSING2", driver = "OpalDriver")
  builder$append(server = "study3",
                 url = "http://192.168.56.100:8080/", 
                 user = "administrator", password = "datashield_test&", 
                 table = "SURVIVAL.EXPAND_NO_MISSING3", driver = "OpalDriver")
  logindata <- builder$build()
  
  connections <- DSI::datashield.login(logins = logindata, assign = TRUE, symbol = "D") 
  
  # make sure that the outcome is numeric 
  ds.asNumeric(x.name = "D$cens",
            newobj = "EVENT",
            datasources = connections)

  ds.asNumeric(x.name = "D$survtime",
            newobj = "SURVTIME",
            datasources = connections)

  dsSurvivalClient::ds.Surv(time='SURVTIME', event='EVENT', objectname='surv_object')

  dsSurvivalClient::ds.coxphSLMAassign(formula = 'surv_object ~  D$female', 
             dataName = 'D', datasources = connections, 
	objectname = 'coxph_serverside')
  
  dsSurvivalClient::ds.coxphSummary(x = 'coxph_serverside')

  # clear the Datashield R sessions and logout
  datashield.logout(connections)

## End(Not run)

neelsoumya/dsSurvivalClient documentation built on July 1, 2023, 10:32 p.m.