Learn R Programming

⚠️There's a newer version (1.4.3) of this package.Take me there.

SPUTNIK: an R package for peak selection of Mass spectrometry imaging data

If you find SPUTNIK useful, please consider citing our work :)

Inglese, P., Correia, G., Takats, Z., Nicholson, J. K. & Glen, R. C. (2018). SPUTNIK: an R package for filtering of spatially related peaks in mass spectrometry imaging data. Bioinformatics (Oxford, England)

Description

SPUTNIK is an R package consisting of a series of tools to filter mass spectrometry imaging peaks characterized by a noisy or unlikely spatial distribution. SPUTNIK can produce mass spectrometry imaging datasets characterized by a smaller but more informative set of peaks, reduce the complexity of subsequent multi-variate analysis and increase the interpretability of the statistical results.

Contact

Install from CRAN

To install the CRAN package, run the command:

install.packages("SPUTNIK")

Install from source

To install it, run the command:

devtools::install_git("https://github.com/paoloinglese/SPUTNIK.git")

Example SPUTNIK workflow on MALDI mass spectrometry imaging data

https://github.com/paoloinglese/SPUTNIK/blob/master/tutorials/workflow_maldi.html

Example SPUTNIK workflow on DESI mass spectrometry imaging data

http://htmlpreview.github.com/?https://github.com/paoloinglese/SPUTNIK/blob/master/tutorials/workflow_desi.html

Example data

Two mass spectrometry imaging datasets in RData format are available in a separate repository:

https://github.com/paoloinglese/SPUTNIKexamples

Copy Link

Version

Install

install.packages('SPUTNIK')

Monthly Downloads

347

Version

1.3.3

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Paolo Inglese

Last Published

May 17th, 2021

Functions in SPUTNIK (1.3.3)

binSupervised,msi.dataset-method

Return a binary mask generated applying a supervised classifier on peaks intensities using manually selected regions corresponding to off-sample and sample-related areas.
plot,ms.image,missing-method

refAndROIimages

Compute the reference image and the ROI mask.
gini.index

Gini index.
getShapeMSI,msi.dataset-method

Returns the geometrical shape of MSI dataset
closeImage,ms.image-method

Apply morphological closing to binary image.
ms.image-class

ms.image-class definition.
msi.dataset-class

msi.dataset-class S4 class definition containing the information about the mass spectrometry imaging dataset.
getIntensityMat,msi.dataset-method

Return the peaks intensity matrix.
getMZ,msi.dataset-method

Return the m/z vector.
normIntensity,msi.dataset-method

Normalize the peaks intensities.
ovarianDESIDoria2016

Load the example DESI-MSI data.
CSRPeaksFilter

Performs the peak selection based on complete spatial randomness test.
NMI

Normalized mutual information (NMI).
smoothImage,ms.image-method

Apply Gaussian smoothing to an MS image.
msImage

spatial.chaos

Spatial chaos measure.
binKmeans,msi.dataset-method

Return a binary mask generated applying k-means clustering on first 10 principal components of peaks intensities.
binKmeans2,msi.dataset-method

Return a binary mask generated applying k-means clustering on peaks intensities. A finer segmentation is obtained by using a larger number of clusters than 2. The off-sample clusters are merged looking at the most frequent labels in the image corners. The lookup areas are defined by the kernel size.
msiDataset

countPixelsFilter

Filter based on the minimum number of connected pixels in the ROI.
splitPeaksFilter

Test for the presence of split peaks.
globalPeaksFilter

Reference similarity based peak selection.
invertImage,ms.image-method

Invert the colors of an MS image.
removeSmallObjects,ms.image-method

Remove binary ROI objects smaller than user-defined number of pixels
createPeaksFilter

Generate a peak filter object.
varTransform,msi.dataset-method

Variance stabilizing transformation.
scatter.ratio

Pixel scatteredness ratio.
bladderMALDIRompp2010

Load the example MALDI-MSI data.
SSIM

Structural similarity index (SSIM).
binOtsu,ms.image-method

Binarize MS image using Otsu's thresholding.
applyPeaksFilter,msi.dataset-method

Apply the results of a peaks filter.