Man pages for kueckelj/SPATA2
A Toolbox for Spatial Gene Expression Analysis

acrossacross
addAutoencoderSetUpAdd the set up of a neural network
add_dbscan_variableAdd tissue section variable
addExpressionMatrixAdd an expression matrix
addFeaturesAdd a new feature
addGeneFeaturesAdd new gene features
addGeneMetaDataAdd gene meta data to the object
addGeneSetAdd a new gene set
addImageDirAdd individual image directories
add_modelsAdd models to a data.frame
add_outline_variableAdd outline variable
addPointsBaseAdd points to base surface plot
addSpCorClusterAdd cluster results of spatial correlation results
adjustDirectoryInstructionsAdjust default instructions
adjustGeneSetDfFilter gene-set data.frame
alignImageAnnotationAlign image annotation
all_bcsp_distancesObtain a all barcode-spots distances
all_color_palettesColor palette names
allColorpalettesValid colorpanels & -spectra
append_polygon_dfAppend polygon df
are_all_area_or_distTest area or distance input
argument_dummyArgument dummy
arrange_as_polygonArrange observations as polygon
asGiottoTransform 'spata2' object to 'Giotto'
asHistologyImageConvert to class 'HistologyImage'
asHistologyImagingConvert to class 'HistologyImaging'
asSeuratTransform 'SPATA2' to 'Seurat'
asSingleCellExperimentTransform to 'SingleCellExperiment'
asSPATA2Transform to 'spata2' object object
as_SPATA2_distDistance transformation
asSpatialTrajectoryTransform to 'SpatialTrajectory'
asSummarizedExperimentTransform to 'SummarizedExperiment'
as_unitTransform distance and area values
asVisiumV1Transform 'HistologyImage' to 'VisiumV1'
attachUnitAttach unit to distance
average_genesaverage_genes
barcodesToImageAnnotationCreate image annotations from a list of barcodes
bin_by_angleBin barcode-spots by angle
bin_by_expansionBin barcode-spots by area extension
binwidth_dummybinwidth
buffer_areaBuffer area
cds_dummyTitle
check_all_barcodesCheck barcodes of all matrices and data.frames
check_assignCheck assign input
check_atdfCheck assessed trajectory data.frame
check_availabilityGives feedback if object was not found
check_color_toCheck color to
check_compiled_trajectory_dfCheck compiled trajectory data.frame
check_coordinate_variablesCheck coordinate variables
check_coords_dfCheck coords data.frame
check_customized_trendsCheck customized trend list
check_dea_dfCheck de data.frame
check_displayCheck display input
check_feature_dfCheck feature data.frame
check_featuresCheck feature variables input
check_genesCheck gene input
check_gene_setsCheck gene set input
check_methodCheck method input
check_monocle_inputCheck monocle input
check_monocle_packagesMakes sure that both packages are installed
check_objectCheck spata object input
check_patternCheck pattern input
checkpointShiny feedback messages
check_ptCheck pt input
check_sampleCheck sample input
check_savingCheck saving input
check_segmentCheck segment name
check_slot_coordinatesCheck spata slots
check_smoothCheck smooth input
check_spata_dfCheck coordinate data.frame
check_stdfCheck summarized trajectory data.frame
check_summarized_trajectory_dfCheck stdf-input
check_toGives feedback about input validity
check_trajectoryCheck trajectory name input
check_trajectory_binwidthCheck trajectory binwdith input
check_uniform_genesCheck uniform genes input
check_variablesCheck variables
close_area_dfClose area encircling
clrpclrp
clusteringA list of data.frames that contain clustering variables for...
clusterSpCorResultsCluster genes according to their expression profile
cnv_refA list of reference data for copy number variation analysis...
cnv_regions_dfA data.frame necessary for cnv-analysis. Contains information...
color_vectorGet vector of colors
compute_angle_between_two_pointsCompute angle between two points
computeCnvByChrArmCompute CNV by chromosome arm
compute_distanceCompute the distance between to points
computeGeneMetaDataCompute gene summary statistics
containsCNVCheck availability of miscellaneous content
containsHistologyImagingCheck availability of 'HistologyImaging' object
containsImageCheck availability of an image
containsPixelScaleFactorCheck availability of pixel scale factor
countImageAnnotationTagsCount image annotation tags
createHistologyImagingCreate object of class 'HistologyImaging'
createImageAnnotationsAdd image annotations
create_model_dfCreate model data.frame
createSegmentationDeprecated in favor of 'createSpatialSegmentation()'
createSpatialSegmentationInteractive sample segmentation
createSpatialTrajectoriesAdd spatial trajectories
cropSpataObjectSubset by x- and y-range
currentSpata2VersionThe current version of 'SPATA2'
data_counts-classdata_counts object
deaA nested list. First layer is named by the sample name....
default_instructions-classdefault instructions
deprecatedInfoInformation about deprecated aspects
dim_red-classdim_red object
discardExpressionMatrixDiscard an expression matrix
discardFeaturesDiscard features
discardGeneFeaturesDiscard gene features
discardGenesDiscard genes
discardGeneSetsDiscard gene sets
discardImageAnnotationsDiscard image annotations
downloadPubExampleDownload data from the publication
downloadRawDataDownload raw Visium output
downloadSpataObjectDownload 'spata2' objects
dropped_df_dummydropped_df
examineClusterResultsExamine clustering results
exchangeImageExchange image
exportdummy
extract_unitExtract distance units
extract_valueExtract distance value
filterDeaDfPostprocess de-analysis results
findMonocleClustersCluster sample via monocle3
findNearestNeighbourClustersCluster sample via nearest neighbour analysis
findSeuratClustersCluster sample via Seurat
flexible_call_dummyflexible_call_dummy
flipAllMirror invert image and coordinates
flipCoordsDeprecated
flip_coords_dfFlip coordinate variables
gene_pos_dfA data.frame necessary for cnv-analysis. Contains information...
gene_set_pathgene_set_path
geom_point_fixedPoints (fixed size ~ window ratio)
GeomPointFixedGeomPointFixed
geom_segment_fixedSegments (fixed size ~ window ratio)
GeomSegmentFixedGeomSegmentFixed
geom_text_fixedText (fixed size ~ window ratio)
GeomTextFixedGeomTextFixed
getActiveMatrixNameObtain name of currently active data matrix
getAutoencoderAssessmentObtain information about the optimal neural network set up
getAutoencoderSetUpObtain information on neural network
getBarcodesObtain specific barcodes
getBarcodesInPolygonObtain barcodes in polygon
getBarcodeSpotDistanceObtain barcode spot distances
getBarcodeSpotDistancesObtain distances between barcodes
getCCDObtain center to center distance
getChrRegionsDfObtain chromosome information
getCnvFeatureNamesObtain features names under which cnv-analysis results are...
getCnvGenesDfObtain CNV results by gene
getCnvResultsObtain copy-number-variations results
getCoordsCenterObtain coordinate center
getCoordsDfObtain spatial coordinates
getCoordsRangeObtain coordinate range
getDeaLfcNameObtain LFC name
getDeaOverviewObtain info on de-analysis storage
getDeaResultsDfObtain de-analysis results
getDefaultInstructionsObtain default argument inputs
getDimRedDfObtain dim red data.frame
getExpressionMatrixNamesObtain names of stored expression matrices
getFeatureDfObtain feature data
getFeatureNamesObtain feature names
getFeatureValuesObtain unique categorical feature values
getFeatureVariablesObtain a feature variable
getFromSeuratSafe extraction
getGeneCountsObtain total number of gene counts
getGeneDistMtrObtain distance measurements of spatially correlated genes
getGeneFeatureNamesObtain feature names of the gene meta data
getGeneMetaDataObtain gene meta data
getGenePosDfObtain gene information
getGenesObtain gene names
getGeneSetDfObtain gene set data.frame
getGeneSetOverviewOverview about the current gene sets
getGeneSetsObtain gene set names
getGroupingOptionsObtain variable names that group the barcode spots
getGroupNamesObtain group names a grouping variable contains
getGseaDfObtain enrichment data.frame
getGseaResultsObtain enrichment results
getIasBinAreasCalculate IAS bin area
getIasDfObtain image annotation screening data.frame
getIasExpansionObtain expanded Image Annotation polygons
getImageObtain histology image
getImageAnnotationObtain object of class 'ImageAnnotation'
getImageAnnotationsObtain list of 'ImageAnnotation'-objects
getImageCenterObtain image center
getImageDfObtain melted image
getImageDimsObtain image dimensions/ranges
getImageDirLowresObtain image directories
getImageInfoObatain image information
getImageObjectObtain object of class 'HistologyImage'
getImageOriginObtain image origin
getImageRasterObtain image raster-(information)
getImageSectionsByBarcodeObtain image sections by barcode spot
getImgAnnAreaObtain area of image annotation
getImgAnnBarcodesObtain barcodes by image annotation tag
getImgAnnCenterObtain center of an image annotation
getImgAnnCenterBcspObtain center barcode-spot
get_img_ann_helperObtain image annotation screening data.frame
getImgAnnIdsObtain unit of method
getImgAnnOutlineDfObtain image annotation border data.frame
getImgAnnRangeObtain image annotations range
getImgAnnSfObtain simple feature
getImgAnnSummaryDfObtain image annotation summary
getImgAnnTagsObtain image annotations tags
getInitiationInfoObtain information about object initiation
getMatrixObtain count and expression matrix
getModelEvaluationDfObtain model evaluation
getPixelDfObtain pixel data.frame
getPixelScaleFactorObtain scale factor for pixel to Euol conversion
getProjectionDfObtain trajectory projection
getPrResultsObtain pattern recognition results
getResultsDfObtain results stored in data.frames
getResultsVecObtain screening results stored in vectors
getSampleAreaSizeObtain sample area size
getSampleNameObtain name of 'SPATA2' object
getSegmentationNamesObtain segmentation variable names
getSegmentNamesObtain segment names
getSignatureEnrichmentObtain signature enrichment
getSmrdResultsDfObtain IAS results (data.frame)
getSpataDfObtain a spata-data.frame
getSpataDirObtain SPATA2 object directory
getSpatialMethodObtain spatial method
getSpatialTrajectoryObtain objects of class 'SpatialTrajectory'.
getSpatialTrajectoryIdsObtain spatial trajectory IDs
getSpCorClusterObtain cluster results based on spatial correlation analysis
getSpCorResultsObtain spatial correlation results
getStsDfObtain spatial trajectory screening data.frame
getTissueOutlineDfObtain outline barcode spots
getTrajectoryDfObtain a trajectory data.frame
getTrajectoryIdsObtain trajectory ids
getTrajectoryLengthObtain length of trajectory
getTrajectoryNamesDeprecated.
getTrajectoryScreeningDfDeprecated
getTrajectorySegmentDfObtain trjectory course
getVariableNamesObtain variable names
ggpInitInitiate ggplot2 layering
ggpLayerAxesCleanDisplay clean axes
ggpLayerAxesSIDisplay axes with SI units of length
ggpLayerColorGroupScaleAdd group specific color spectrum
ggpLayer_dummyggpLayer
ggpLayerEncirclingIASAdd IAS area expansion
ggpLayerFrameFix ggplot frame
ggpLayerFrameByCoordsSet plot limits
ggpLayerGroupOutlineAdd group outline
ggpLayerHorizonIASAdd IAS area horizon
ggpLayerImageAdd histology image
ggpLayerImgAnnOutlineAdd borders of annotated structures
ggpLayerImgAnnPointerAdd pointer towards image annotations
ggpLayerImgAnnRectAdd a rectangular around an image annotation
ggpLayerLineplotAidAdd horizontal and vertical lines
ggpLayerRectAdd a rectangular to the plot
ggpLayerScaleBarSIAdd a scale bar in SI units
ggpLayerThemeCoordsAdd coordinates theme
ggpLayerTissueOutlineAdd a hull that outlines the tissue
ggpLayerTrajectoriesAdd trajectory layer
ggpLayerZoomSet plot limits manually
ggplot_dummyggplot
ggplot_familyggplot_family
gradientToModelIASCreate input for 'model_add'
gsdfThe default collection of frequently used gene-sets
HistologyImage-classThe 'HistologyImage' - Class
HistologyImaging-classThe 'HistologyImaging' - Class
hlpr_add_barcode_suffixMake sure that barcodes are spata-like
hlpr_add_old_coordsAdds old coordinates
hlpr_adjust_legend_sizeAdjusts the size of discrete legend points
hlpr_assign_argumentsAssign arguments to calling function
hlpr_breaksCalculates breaks for heatmap according to input matrix
hlpr_compare_samplesCompare samples within an object
hlpr_dist_mtr_to_dfConvert distance matrix to distance data.frame
hlpr_gene_set_nameRemoves the class part of a gene set string
hlpr_geom_trajectory_fitEasy switch between geom line and and geom smooth
hlpr_image_add_onProvides the image as ggplot background
hlpr_join_with_color_byJoin with single value
hlpr_labs_add_onReturn customized ggplot:labs()
hlpr_normalize_imapNormalize gene or gene set values
hlpr_normalize_vctrNormalize gene or gene set values
hlpr_one_distinctNumber of distinct values equal to 1?
hlpr_process_spatial_correlation_clusterProcess spatial correlation results
hlpr_rank_trajectory_trendsRank trajectory trends.
hlpr_save_spata_objectSave spata object inside functions
hlpr_scatterplotColor to + scatterplot helper
hlpr_smoothSmooth variables spatially
hlpr_smooth_shinySmooth variable spatially in mini-shiny-apps
hlpr_subset_acrossSubset the across-variables
hlpr_summarize_trajectory_dfJoin and summarize compiled trajectory data.frames
hlpr_vector_projectionPerform vector projection
hlpr_widen_trajectory_dfWiden trajectory data.frame
identifyTissueOutlineIdentify tissue outline
identifyTissueSectionsIdentify tissue sections
ImageAnnotation-classThe 'ImageAnnotation' - Class
image_annotationsA list of lists of image annotations for specific 'SPATA2'...
imageAnnotationScreeningImplementation of the IAS-algorithm
ImageAnnotationScreening-classThe 'ImageAnnotationScreening' - Class
imageAnnotationToSegmentationConvert image annotation to segmentation
image_dummyimage_dummy
include_tissue_outlineInclude spatial extent of tissue sections in analysis
inferSingleCellGradientCount cells depending on distance to image annotation
initiateSpataObject_10XInitiate a 'spata2' object from 10X Visium
initiateSpataObject_CountMtrInitiate a 'spata2' object from a raw count matrix
initiateSpataObject_EmptyInitiate an empty 'spata2' object
initiateSpataObject_ExamplesInitiate a 'spata2' object from example data sets
initiateSpataObject_ExprMtrInitiate spata object from scaled expression matrix
intersect_polygonsTest polygon intersection
is_areaTest area input
is_distTest distance input
is_unit_areaTest unit of area input
is_unit_distTest unit of length input
joinWithJoin barcodes with additional variables
joinWithPcaJoin barcodes with additional variables
legendBottomggplot2 legend manipulation
loadGeneSetDfLoad gene set data.frame
loadGSDFOriginal load gene set data.frame
loadImageLowresLoad known images
loadSpataObjectLoad corresponding objects
makeContent.resizingSegmentsGrobMake content for segments grob
makeContent.resizingTextGrobMake content for text grob
mapImageAnnotationTagsImage annotation and barcode intersection
mergeGroupsLump groups together
mergeTissueSectionsMerge tissue sections
method_hclustmethod_hclust
moduleAddGeneSetsServerServer of the add gene sets module
moduleAddGeneSetsUIUI of the add gene sets module
moduleSurfacePlotServerServer of the surface plot module
moduleSurfacePlotUIUI of the surface plot module
nBarcodesNumber of barcodes
nCountsNumber of counts
nGenesNumber of genes
nImageAnnotationsNumber of image annotations
normalizeNormalize variable
nSpatialTrajectoriesNumber of spatial trajectories
object_dummyobject
pb_dummypb
pheatmapde_df
plotAutoencoderAssessmentPlot total variance of different neural networks
plotAutoencoderResultsPlot scaled vs. denoised expression
plotBarchartPlot distribution of discrete variables
plotBoxplotPlot numeric distribution and statistical tests
plotClockplotPlota clockplot
plotCnvHeatmapPlot CNV Heatmap
plotCnvLineplotPlot CNV Lineplot
plotDeaDotPlotPlot differentially expressed genes
plotDeaGeneCountPlot the number of differently expressed genes of certain...
plotDeaHeatmapPlot differentially expressed genes
plotDeaPvaluesPlot the p-value and log fold change distribution of...
plotDeaSummaryPlot a summary of differential expression analysis results
plotDeaVolcanoPlot gene expression testing results
plotDendrogramdummy
plotFourStatesPlot state plot
plotGeneDendrogramVisualize clustering results
plotGseaDotPlotPlot gene set enrichment
plotIasBarplotPlot IAS barplot
plotIasEvaluationPlot IAS evaluation per variable-model pair
plotIasHeatmapPlot IAS heatmap
plotIasLineplotPlot IAS lineplot
plotIasLineplotFittedPlot IAS model fitting
plotIasRidgeplotPlot IAS rideplot
plotImagePlot histology image
plotImageAnnotationsPlot image annotations
plotImageGgplotPlot histology image (ggplot2)
plotImagesGgplotPlot histology images (ggplot2)
plotMosaicplotPlot mosaic plot
plotOverviewPlot overview of S4 objects
plotPcaVariationPlot Pca Variation
plotPseudotimeMonocle3 Pseudotime
plotRiverplotPlot riverplots
plotScatterplotPlot numeric variables as a scatterplot
plot_screening_evaluationHelper
plotSpatialTrajectoriesPlot spatial trajectory
plotStatisticsInteractivePlot distribution of variables interactively
plotSurfacePlot the surface of the sample
plotSurfaceAveragePlot several surface plots colored by gene averages
plotSurfaceBasePlot surface with R base plotting
plotSurfaceComparisonPlot several surface plots colored by numeric variables
plotSurfaceIASPlot screening area of IAS-algorithm
plotSurfaceQuantilesPlot a surface plot colored by binned numeric variables
plotSurfaceSCPlot single cells on surface
plotTrajectoryBarplotPlot categorical trajectory dynamics
plotTrajectoryEvaluationPlot STS evaluation per variable-model pair
plotTrajectoryHeatmapPlot trajectory expression dynamic in heatmap
plotTrajectoryLineplotPlot continuous trajectory dynamics
plotTrajectoryLineplotFittedPlot trajectory model fitting
plot_type_dummyplot_type
plotUmapPlot dimensional reduction
plotVolcanoCompare evaluation of spatially opposing fits
printAutoencoderSummaryPrint autoencoder summary
printDeaOverviewPrint overview of all conducted de-analysis
printDefaultInstructionsPrint current default settings
print_familyprint
printGeneSetOverviewPrint overview about the current gene sets
process_expand_inputProcess expand input
process_rangesProcess input ranges
process_seurat_objectWrapper around Seurat processing functions
project_on_trajectoryProject barcode spots on a trajectory
project_on_vectorPerform vector projection
reduce_vecReduces vector length
relateToImageAnnotationRelate observations to an image annotation
relevelGroupsRelevel groups of grouping variable
removeAnnotationRemove annotation
renameFeaturesRename features
renameGroupsRename cluster/group names
renameImgAnnRename image annotation ID
resetImageJustificationReset image justification
resizingSegmentsGrobUsed for GeomSegmentFixed
resizingTextGrobUsed for GeomTextScaled
rotateAllRotate image and coordinates
rotate_coords_dfRotate coordinate variables pairs
runAutoencoderAssessmentAssessment of Neural Network Set Up
runAutoencoderDenoisingDenoise expression matrix
runBayesSpaceClusteringClustering with BayesSpace
runCnvAnalysisIdentify large-scale chromosomal copy number variations
runDEAFind differently expressed genes
runGSEACompute gene set enrichment
runPcaRun Principal Component Analysis
runSeuratClusteringClustering with Seurat
runSparkxIdentify genes of interest with SPARKX
runSpatialCorrelationAnalysisInitiate gene clustering analysis based on spatial patterns
runTsneRun t-Stochastic Neighbour Embedding
runUmapRun UMAP-Analysis
sample_namesample_name
saveGeneSetDfSave a gene set data.frame
saveSpataObjectSave corresponding objects
scaleAllScale image and coordinates
scale_color_add_onggplot2 - color add on
scale_coords_dfScale coordinate variable pairs
scale_factorsList of scale factors for Visium input.
sc_deconvolutionList of data.frames of single cell deconvolution. Names of...
section_dummySection dummy
setActiveExpressionMatrixDenote the default expression matrix
setAutoencoderAssessmentSet results of autoencoder assessment
setBarcodesSet barcodes
setCCDSet center to center distance
setCnvResultsSet cnv-results
setCoordsDfSet the coordinates
setCountMatrixSet data matrices
setDefaultSet object specific default
setDefaultGroupingDefault grouping
setDefaultInstructionsSet default instructions
setDefaultTrajectoryObtain dimensional reduction data
set_dummyset
setFeatureDfSet feature data.frame
setGeneSetDfSet the gene-set data.frame
setImageAnnotationSet image annotations
setImageDirLowresSet image directories
setImageObjectSet image object
setImageOriginSet image origin
setInitiationInfoSet initiation information
setOutlineVarNameSet outline variable name
setPcaDfSet dimensional reductions data.frames
setPixelScaleFactorSet pixel scale factor
setPrResultsSet results of pattern recognition methods
setSpataDirSet SPATA2 directory
setSpatialMethodSet the 'SpatialMethod' object
setSpatialMethodInfoSet information of 'SpatialMethod' object
setSpatialMethodSlotSet slot content of 'SpatialMethod' object
setSpCorResultsSet results of spatial correlation analysis
setTissueOutlineSet tissue outline
setTrajectorySet trajectories
seurat_object_dummyTitle
showColorsShow color palettes and spectra
showModelsShow spatial gradient screening models
smoothSpatiallySmooth numeric variables spatially
spata2-classThe 'spata2'- Class
SpatialMethod-classThe 'SpatialMethod' - Class
SpatialSegmentation-classThe 'SpatialSegmentation' - Class
spatial_segmentationsA list of lists of spatial segmentations for specific...
SpatialSegment-classThe 'SpatialSegment' - Class
spatial_trajectoriesA list of lists of spatial spatial_trajectories for specific...
spatial_trajectory-classspatial_trajectory object
SpatialTrajectory-classThe 'SpatialTrajectory' - Class
spatialTrajectoryScreeningThe Spatial Trajectory Screening algorithm
SpatialTrajectoryScreening-classThe 'SpatialTrajectoryScreening' - class
subsetByBarcodesSubsetting by barcodes
subsetByGenesSubset by genes
summarize_formulasList of summarizing formulas
summarizeIASSummarize IAS-results
tab_surface_plots_appSurface plot tab - classic
tab_surface_plots_returnSurface plot tab - return
theme_lineplot_gradientggplot2 themes
tissueOutlineIdentifiedCheck availability of tissue information
Trajectory-classThe 'Trajectory' - Class
transfer_slot_contentTransfer S4 slot content
transform_area_si_to_pixelConvert area in SI units to pixel
transform_dist_si_to_pixelConvert from European Units of Length to pixels
transform_pixel_to_area_siConverts from pixel to area in SI units
transform_pixel_to_dist_siConvert from pixels to European units of length
transform_pixel_to_sidummy
transformSeuratToSpataTransform seurat-object to spata-object
transformSpataToCDSTransform spata-object to cell-data-set (Monocle3)
transformSpataToSeuratTransform spata-object to a seurat-object
translate_shape_stringinspired from...
update_dummyupdate
updateSpataObjectUpdate spata-object from SPATA to SPATA2
validActivationFunctionsObtain valid argument inputs
validationValidate object input
variablevariable
variable_numvariable_num
variables_numvariables_num
Visium-classThe 'Visium' - Class
visium_coordsA data.frame that contains all barcode spots of the Visium...
vselectSelect vector with tidyselect functions
kueckelj/SPATA2 documentation built on March 16, 2024, 10:25 a.m.