columna API reference - v0.4.0
    Preparing search index...

    Function coxPH

    • Cox proportional hazards (Breslow ties).

      • censor: 0 = event, 1 = right-censored
      • start: optional counting-process left endpoint → risk set is (start, stop]
      • strata: stratified baselines, shared β
      • frailty: { group }: shared gamma frailty (EM / penalized offset)
      • cluster: cluster-robust (sandwich) SE from score residuals
      • eventType + cause: cause-specific competing risks (other events censored)

      Parameters

      • time: ArrayLike<number | null | undefined>
      • X: ArrayLike<ArrayLike<number>>
      • Optionaloptions: {
            cause?: string | number;
            censor?: ArrayLike<number | null | undefined>;
            cluster?: ArrayLike<string | number | null | undefined>;
            confidence?: number;
            eventType?: ArrayLike<string | number | null | undefined>;
            frailty?: {
                bands?: ArrayLike<string | number>;
                distribution?: "gamma";
                group: ArrayLike<string | number>;
                process?: "piecewise" | "ar1";
            };
            maxIter?: number;
            names?: string[];
            start?: ArrayLike<number | null | undefined>;
            strata?: ArrayLike<string | number | null | undefined>;
        }
        • Optionalcause?: string | number

          Cause of interest for cause-specific Cox (other events treated as censored).

        • Optionalcensor?: ArrayLike<number | null | undefined>
        • Optionalcluster?: ArrayLike<string | number | null | undefined>
        • Optionalconfidence?: number
        • OptionaleventType?: ArrayLike<string | number | null | undefined>

          Competing-risk cause labels per row; used with cause.

        • Optionalfrailty?: {
              bands?: ArrayLike<string | number>;
              distribution?: "gamma";
              group: ArrayLike<string | number>;
              process?: "piecewise" | "ar1";
          }
          • Optionalbands?: ArrayLike<string | number>

            Piecewise time bands (per row); shared gamma frailty estimated within each band×group.

          • Optionaldistribution?: "gamma"
          • group: ArrayLike<string | number>
          • Optionalprocess?: "piecewise" | "ar1"

            piecewise (default) or AR(1) shrinkage across ordered bands.

        • OptionalmaxIter?: number
        • Optionalnames?: string[]
        • Optionalstart?: ArrayLike<number | null | undefined>
        • Optionalstrata?: ArrayLike<string | number | null | undefined>

      Returns CoxPHResult

    Settings
    Member Visibility