Sunclarco Model

Description

Model for Survival Analysis of Unbalanced Clusters using Archimedes Copula's (Note: you can also add other fields like references, authors,... See which ones are necessary)

Usage

1
2
3
SunclarcoModel(data, time, status, clusters, covariates, stage = 1,
  copula = "Clayton", marginal = "Weibull", n.piecewise = 20,
  init.values = NULL, verbose = FALSE, summary.print = TRUE)

Arguments

data

Input dataframe containing all variables.

time

Which variable name is the time covariate?

status

Which variable name is the status covariate? (more explanation?)

clusters

Which variable name is the cluster covariate?

covariates

Vector of 1 or more other covariates to be included in the model. If necessary a covariate should be a factor in the data frame. (NOTE: MULTIPLE COVARIATES NEED TO BE TESTED!!!)

stage

Can be 1 or 2 for 1 or 2 staged approached. See Details for more information.

copula

Which copula to user? Can either be "Clayton" or "GH" for Gumbel-Hougaard.

marginal

Which marginal to use? Can either be "Weibull", "PiecewiseExp" for Piecewise Exponential or "Cox" for Cox Regression.

n.piecewise

For marginal="PiecewiseExp", how many pieces should the Piecewise Exponential have? (Default = 20)

init.values

Initial values for parameters. This depends on the choice of the parameters stage, copula and marginal. See Details for more information. If no initial parameters are given, they will be chosen automatically (See Details for more information).

verbose

Print some in-between results as well as computation progress.

summary.print

Logical value to print a short summary at the end of the computation.

Details

WRITE DIFFERENT SECTIONS SECTION 1: Which marginals + copula's are available for stage 1 and 2 SECTION 2: Which parameters have to be given initially in all scenarios (stage 1 and 2) and in which order!! (note: the order will always be like this: lambdas, rho, theta, betas) SECTION 3: How are the initial parameters chosen if done automatically?

Value

S3 List object

Parameters

Data frame containing estimates and standard errors of parameters.

Kendall_Tau

Vector containing estimate and standard error of Kendall's Tau.

ParametersCov

If available, covariance matrix of the parameters. For 2-stage approaches this is only available for the Weibull marginal.

logllh

The log-likelihood value.

parameter.call

A list containing all arguments given to the function, as well as the initial parameter values and the elapsed time.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 
data("insem",package="Sunclarco")
result1 <- SunclarcoModel(data=insem,time="Time",status="Status",
                          clusters="Herd",covariates="Heifer",
                          stage=1,copula="Clayton",marginal="Weibull")

summary(result1)

result2 <- SunclarcoModel(data=insem,time="Time",status="Status",
                          clusters="Herd",covariates="Heifer",
                          stage=2,copula="Clayton",marginal="Cox",
                          verbose=TRUE)
summary(result2)
## ADD MORE EXAMPLES? => THESE EXAMPLES SHOULD BE USED IN VIGNETTE?

## End(Not run)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.