List of functions in DataSHIELD v6.0 (as of 1 June 2020)
Table of Contents
Intro
We are currently looking at reworking the list of functions to make them easier to use, and to find which ones you would find useful. If there is interest, we could add tags to functions so that you only load functions with certain tags like "beginners", "aggregate only" etc. To register interest in this, please email datashield@newcastle.ac.uk .
Data Preparation functions (generally of type "Assign")
Coercing functions
ds.asCharacter
ds.asInteger
ds.asMatrix
ds.asDataMatrix
ds.asList
ds.asNumeric
ds.asFactor
ds.asLogical
Number manipulation functions
ds.make
ds.Boole
- ds.list
ds.log
- ds.exp
- ds.rep
ds.seq
- ds.c
Data Frame/List manipulation functions
- ds.completeCases
- ds.replaceNA
- ds.sample
ds.merge
ds.recodeValues
- ds.dataFrame
- ds.dataFrameSubset
ds.dataFrameFill
ds.dataFrameSort
ds.tapply
ds.tapply.assign
ds.vectorCalc
ds.list
ds.unList
- ds.assign
ds.cbind
ds.rbind
Factor manipulation functions
ds.changeRefGroup
- ds.recodeLevels
Administrative functions
ds.listClientsideFunctions
ds.listServersideFunctions
ds.message
ds.setSeed
ds.listDisclosureSettings
- ds.ls
- ds.rm
- ds.testObjExists
- ds.look
ds.listOpals
ds.setDefaultOpals
Data Analysis functions (generally of type "Aggregate")
Data structure queries
ds.levels
ds.length
ds.exists
- ds.colnames
ds.names
ds.dim
- ds.isValid
- ds.isNA
ds.numNA
ds.class
Summary Statistics Functions
- ds.mean
ds.meanByClass
ds.meanSdGp
- ds.quantileMean
ds.rowColCalc
- ds.var
ds.cov
ds.cor
ds.corTest
ds.summary
Matrices Functions
ds.matrix
ds.matrixDiag
ds.matrixMult
ds.matrixDet
ds.matrixDimnames
ds.matrixTranspose
ds.matrixDet.report
ds.matrixInvert
Table functions
- ds.table
Survival Analysis functions
- ds.lexis
ds.reShape
Distribution Generating functions
ds.rNorm
ds.rBinom
- ds.rPois
ds.rUnif
Modelling Functions
ds.glm
ds.glmSLMA
ds.lmerSLMA
ds.glmerSLMA
Data Presentation functions
Plotting functions
ds.histogram
ds.densityGrid
ds.heatmapPlot
- ds.contourPlot
- ds.scatterPlot
Deprecated functions
These functions in the left hand column shouldn't be used, as a rule. There is information contained within the help for each of them detailing which function you should use instead, that does all of what the deprecated function did do, and more!
Deprecated function | Replacement function |
---|---|
ds.subset | ds.dataFrameSubset |
ds.subsetByClass | ds.dataFrameSubset |
ds.table1D | ds.table |
ds.table2D | ds.table |
Generating the list of available functions yourself
See: /wiki/spaces/DSDEV/pages/12943456 for a list of all package manuals (pdf format) containing a list of all functions in our current DataSHIELD release.
Once you have loaded the DataSHIELD packages, you can find a list of all functions within a DataSHIELD package using the ls
command in R/RStudio.
>ls("package:name")
The output below is for the dsBaseClient
but can be substituted for any DataSHIELD package:
> ls("package:dsBaseClient") [1] "ds.asCharacter" "ds.asDataMatrix" "ds.asFactor" "ds.asInteger" "ds.asList" [6] "ds.asLogical" "ds.asMatrix" "ds.asNumeric" "ds.assign" "ds.Boole" [11] "ds.c" "ds.cbind" "ds.changeRefGroup" "ds.class" "ds.colnames" [16] "ds.completeCases" "ds.contourPlot" "ds.cor" "ds.corTest" "ds.cov" [21] "ds.dataFrame" "ds.dataFrameFill" "ds.dataFrameSort" "ds.dataFrameSubset" "ds.densityGrid" [26] "ds.dim" "ds.exists" "ds.exp" "ds.glm" "ds.glmerSLMA" [31] "ds.glmSLMA" "ds.heatmapPlot" "ds.histogram" "ds.isNA" "ds.isValid" [36] "ds.length" "ds.levels" "ds.lexis" "ds.list" "ds.listClientsideFunctions" [41] "ds.listDisclosureSettings" "ds.listOpals" "ds.listServersideFunctions" "ds.lmerSLMA" "ds.log" [46] "ds.look" "ds.ls" "ds.make" "ds.matrix" "ds.matrixDet" [51] "ds.matrixDet.report" "ds.matrixDiag" "ds.matrixDimnames" "ds.matrixInvert" "ds.matrixMult" [56] "ds.matrixTranspose" "ds.mean" "ds.meanByClass" "ds.meanSdGp" "ds.merge" [61] "ds.message" "ds.names" "ds.numNA" "ds.quantileMean" "ds.rbind" [66] "ds.rBinom" "ds.recodeLevels" "ds.recodeValues" "ds.rep" "ds.replaceNA" [71] "ds.reShape" "ds.rm" "ds.rNorm" "ds.rowColCalc" "ds.rPois" [76] "ds.rUnif" "ds.sample" "ds.scatterPlot" "ds.seq" "ds.setDefaultOpals" [81] "ds.setSeed" "ds.subset" "ds.subsetByClass" "ds.summary" "ds.table" [86] "ds.table1D" "ds.table2D" "ds.tapply" "ds.tapply.assign" "ds.testObjExists" [91] "ds.unList" "ds.var" "ds.vectorCalc"
Related content
DataSHIELD Wiki by DataSHIELD is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. Based on a work at http://www.datashield.ac.uk/wiki