summary.colocal: Summarizing the colocalization results

In colocalization: Normalized Spatial Intensity Correlation

Description

This function is used to summarize the results returned from the nsinc.d or nsinc.z function.

Usage

## S3 method for class 'colocal'
summary(object, ...)

Arguments

object	an object of class "colocal", containing the results returned from nsinc.d or nsinc.z.
...	further arguments to be passed from or to other methods.

Details

The results successfully returned from nsinc.d or nsinc.z functions give a list of length 12 encompassing the summarized information of the calculation of colocalization index and the detailed quantities used to calculate the index.

First the summary prints the strategic parameters for calculation of colocalization index, such as, the method, the strata, the edge effect, dimension, study region, membership levels and number of the observed signals in each channel.

The summary also prints the summarized information of proximity sizes, i.e., r, including the r model, the r range, the length of r series, etc.

Then the separate index results are listed at each r. The average colocalization index for the whole image is given at last.

Value

summary.colocal does not return values. It only prints summarized results returned from nsinc.d or nsinc.z functions.

Author(s)

Xueyan Liu, Jiahui Xu, Cheng Cheng, Hui Zhang.

References

Liu, X., Xu, J., Guy C., Romero E., Green D., Cheng, C., Zhang, H. (2019). Unbiased and Robust Analysis of Co-localization in Super-resolution Images. Manuscript submitted for publication.

See Also

nsinc.d, nsinc.z, summary

Examples

## a simulated 3D example data.
data("twolines")

twolines.results <- nsinc.d(data = twolines, membership = "membership",
                            dim = 3, r.model = "r.med")

summary(twolines.results)

colocalization documentation built on Oct. 23, 2020, 5:15 p.m.