ds.heatmapPlot {dsBaseClient} | R Documentation |

Generates a heatmap plot of the pooled data or one plot for each dataset.

ds.heatmapPlot(x = NULL, y = NULL, type = "combine", show = "all", numints = 20, method = "smallCellsRule", k = 3, noise = 0.25, datasources = NULL)

`x` |
a character, the name of a numerical vector |

`y` |
a character, the name of a numerical vector |

`type` |
a character which represents the type of graph to display.
If |

`show` |
a character which represents where the plot should focus
If |

`numints` |
a number of intervals for a density grid object. |

`method` |
a character which defines which heatmap will be created. If |

`k` |
the number of the nearest neghbours for which their centroid is calculated.
The user can choose any value for k equal to or greater than the pre-specified threshold
used as a disclosure control for this method and lower than the number of observations
minus the value of this threshold. By default the value of k is set to be equal to 3
(we suggest k to be equal to, or bigger than, 3). Note that the function fails if the user
uses the default value but the study has set a bigger threshold. The value of k is used only
if the argument |

`noise` |
the percentage of the initial variance that is used as the variance of the embedded
noise if the argument |

`datasources` |
a list of opal object(s) obtained after login in to opal servers;
these objects hold also the data assign to R, as |

The function first generates a density grid and uses it to plot the graph. Cells of the grid density matrix that hold a count of less than the filter set by DataSHIELD (usually 5) are considered invalid and turned into 0 to avoid potential disclosure. A message is printed to inform the user about the number of invalid cells. The ranges returned by each study and used in the process of getting the grid density matrix are not the exact minumum and maximum values but rather close approximates of the real minimum and maximum value. This was done to reduce the risk of potential disclosure.

a heatmap plot

Julia Isaeva, Amadou Gaye, Demetris Avraam for DataSHIELD Development Team

## Not run: # load the file that contains the login details data(logindata) # login and assign the required variables to R opals <- datashield.login(logins=logindata, assign=TRUE) # Example 1: Plot a combined (default behaviour) heatmap plot of the variables 'LAB_TSC' # and 'LAB_HDL' using the method 'smallCellsRule' (default method) that applies a stochastic # noise in the extreme values of the variables' range. ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL') # Example 2: the same as example 1 ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="smallCellsRule", type='combine') # Example 3: similar as example 2 but for type='split' ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="smallCellsRule", type='split') # Example 4: Plot a combined (default behaviour) heatmap plot of the variables 'LAB_TSC' # and 'LAB_HDL' using the method 'deterministic' that plots the exact heatmap plot of the # centroids of each 3 (default number) nearest neighbours. ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="deterministic") # Example 5: the same as example 4 ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="deterministic", k=3, type='combine') # Example 6: similar as example 5 for type='split' ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="deterministic", k=3, type='split') # Example 7: similar as example 6 for k=7 ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="deterministic", k=7, type='split') # Example 8: similar as example 7 for numints=40 ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', numints=40, method="deterministic", k=7, type='split') # Example 9: Plot a combined (default behaviour) heatmap plot of the variables 'LAB_TSC' # and 'LAB_HDL' using the method 'probabilistic' that plots the exact heatmap plot of the # noisy data ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="probabilistic") # Example 10: the same as example 9 ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="probabilistic", noise=0.25, type='combine') # Example 11: the same as example 10 but for bigger level of noise ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="probabilistic", noise=2, type='combine') # Example 12: the same as example 11 but for type='split' ds.heatmapPlot(x='D$LAB_TSC', y='D$LAB_HDL', method="probabilistic", noise=2, type='split') # Example 13: if any of the input variables is a factor then the function fails ds.heatmapPlot(x='D$LAB_TSC', y='D$GENDER') # clear the Datashield R sessions and logout datashield.logout(opals) ## End(Not run)

[Package *dsBaseClient* version 5.0.0 ]