From 5291a622e45c32712dd271499c7b24ecce5113a9 Mon Sep 17 00:00:00 2001 From: jiajic <72078254+jiajic@users.noreply.github.com> Date: Mon, 28 Oct 2024 18:24:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20drieslab?= =?UTF-8?q?/GiottoClass@ec5acccebd20e22aa86edd98f7f18d4ba0e81028=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- LICENSE-text.html | 2 +- LICENSE.html | 2 +- articles/image_tools.html | 4 +- articles/index.html | 2 +- articles/overview.html | 4 +- articles/spatial_geometries.html | 4 +- authors.html | 6 +- index.html | 2 +- news/index.html | 13 ++- pkgdown.yml | 2 +- reference/S3toS4dimObj.html | 2 +- reference/S3toS4spatGridObj.html | 2 +- reference/XY.html | 2 +- reference/activeFeatType-generic.html | 2 +- reference/activeSpatUnit-generic.html | 2 +- reference/addCellMetadata.html | 2 +- reference/addFeatMetadata.html | 2 +- reference/addGiottoImage.html | 2 +- reference/addGiottoImageMG.html | 2 +- reference/addGiottoLargeImage.html | 2 +- reference/addGiottoPoints.html | 2 +- reference/addGiottoPolygons.html | 2 +- reference/addNetworkLayout.html | 2 +- reference/addSpatialCentroidLocations.html | 2 +- .../addSpatialCentroidLocationsLayer.html | 2 +- reference/add_img_array_alpha.html | 2 +- reference/affine.html | 2 +- reference/aggregateStacks.html | 2 +- reference/aggregateStacksExpression.html | 2 +- reference/aggregateStacksLocations.html | 2 +- reference/aggregateStacksPolygonOverlaps.html | 2 +- reference/aggregateStacksPolygons.html | 2 +- reference/anndataToGiotto.html | 2 +- reference/annotateGiotto.html | 2 +- reference/annotateSpatialGrid.html | 2 +- reference/annotateSpatialNetwork.html | 2 +- .../annotate_spatlocs_with_spatgrid_2D.html | 2 +- .../annotate_spatlocs_with_spatgrid_3D.html | 2 +- reference/area.html | 2 +- reference/as.character.html | 2 +- reference/as.data.table.html | 2 +- reference/as.list.html | 2 +- reference/as.matrix.html | 2 +- reference/as.points.html | 2 +- reference/as.polygons.html | 2 +- reference/buffer,giottoPoints-method.html | 8 ++ reference/buffer,giottoPolygon-method.html | 8 ++ reference/buffer,spatLocsObj-method.html | 8 ++ reference/buffer-1.png | Bin 0 -> 160520 bytes reference/buffer.html | 108 ++++++++++++++++++ reference/calculateMetaTable.html | 2 +- reference/calculateMetaTableCells.html | 2 +- reference/calculateOverlap.html | 2 +- reference/calculateOverlapParallel.html | 2 +- reference/calculateOverlapPolygonImages.html | 2 +- reference/calculateOverlapRaster.html | 2 +- reference/calculateOverlapSerial.html | 2 +- .../calculateSpatCellMetadataProportions.html | 2 +- reference/cellMetaObj-class.html | 2 +- reference/centroids-generic.html | 2 +- reference/changeGiottoInstructions.html | 2 +- reference/changeImageBg.html | 2 +- reference/checkPythonPackage.html | 2 +- reference/check_py_for_scanpy.html | 2 +- reference/circleVertices.html | 2 +- reference/colMeans_flex.html | 6 +- reference/colSums_flex.html | 6 +- reference/combineCellData.html | 2 +- reference/combineFeatureData.html | 2 +- reference/combineFeatureOverlapData.html | 2 +- reference/combineMetadata.html | 2 +- reference/combineSpatialCellMetadataInfo.html | 2 +- reference/combineToMultiPolygon.html | 2 +- reference/compatible_spatial_network.html | 2 +- reference/convHull.html | 2 +- reference/convertGiottoLargeImageToMG.html | 2 +- reference/convert_mgImage_to_array_DT.html | 2 +- .../convert_to_full_spatial_network.html | 2 +- .../convert_to_reduced_spatial_network.html | 2 +- reference/copy.html | 2 +- reference/cor_flex.html | 42 +++---- reference/createBentoAdata.html | 2 +- reference/createCellMetaObj.html | 2 +- reference/createDimObj.html | 2 +- reference/createExprObj.html | 2 +- reference/createFeatMetaObj.html | 2 +- reference/createGiottoImage.html | 2 +- reference/createGiottoLargeImage.html | 2 +- reference/createGiottoLargeImageList.html | 2 +- reference/createGiottoObject.html | 2 +- reference/createGiottoObjectSubcellular.html | 2 +- reference/createGiottoPoints.html | 2 +- reference/createGiottoPolygon.html | 2 +- reference/createMetafeats.html | 2 +- reference/createNearestNetObj.html | 2 +- reference/createNearestNetwork.html | 2 +- reference/createNetwork.html | 2 +- reference/createSpatEnrObj.html | 2 +- reference/createSpatLocsObj.html | 2 +- reference/createSpatNetObj.html | 2 +- reference/createSpatialDefaultGrid.html | 2 +- reference/createSpatialDelaunayNetwork.html | 2 +- .../createSpatialFeaturesKNNnetwork.html | 2 +- ...reateSpatialFeaturesKNNnetwork_dbscan.html | 2 +- reference/createSpatialGrid.html | 2 +- reference/createSpatialKNNnetwork.html | 2 +- reference/createSpatialNetwork.html | 2 +- reference/createSpatialWeightMatrix.html | 2 +- reference/create_KNNnetwork_dbscan.html | 2 +- reference/create_average_DT.html | 2 +- reference/create_average_detection_DT.html | 2 +- reference/create_cell_meta_obj.html | 2 +- reference/create_cluster_matrix.html | 2 +- reference/create_dim_obj.html | 2 +- reference/create_expr_obj.html | 2 +- reference/create_feat_meta_obj.html | 2 +- reference/create_featureNetwork_object.html | 2 +- reference/create_giotto_points_object.html | 2 +- reference/create_giotto_polygon_object.html | 2 +- reference/create_nn_net_obj.html | 2 +- reference/create_spat_enr_obj.html | 2 +- reference/create_spat_grid_obj.html | 2 +- reference/create_spat_locs_obj.html | 2 +- reference/create_spat_net_obj.html | 2 +- reference/crop.html | 2 +- reference/cropGiottoLargeImage.html | 2 +- reference/data_access_params.html | 2 +- reference/decomp_affine.html | 2 +- reference/density.html | 2 +- reference/density_giottoLargeImage.html | 2 +- reference/dimObj-class.html | 2 +- reference/dimnames.html | 2 +- reference/dims-generic.html | 2 +- reference/distGiottoImage.html | 2 +- reference/doDeferred.html | 2 +- reference/dot-abbrev_mat.html | 2 +- reference/dot-abbrev_spatlocs.html | 2 +- reference/dot-bitdepth.html | 2 +- .../dot-calculate_centroids_polygons.html | 2 +- .../dot-calculate_distance_and_weight.html | 2 +- reference/dot-calculate_overlap_raster.html | 2 +- reference/dot-check_cell_meta_obj.html | 2 +- reference/dot-check_dim_obj.html | 2 +- reference/dot-check_expr_obj.html | 2 +- reference/dot-check_feat_meta_obj.html | 2 +- .../dot-check_giotto_python_modules.html | 2 +- reference/dot-check_spat_grid_obj.html | 2 +- reference/dot-check_spat_locs_obj.html | 2 +- reference/dot-check_spat_net_obj.html | 2 +- .../dot-check_spatial_location_data.html | 2 +- reference/dot-combine_stack_spatvectors.html | 2 +- reference/dot-create_delaunaynetwork_2d.html | 2 +- reference/dot-create_delaunaynetwork_3d.html | 2 +- .../dot-create_delaunaynetwork_RTriangle.html | 2 +- .../dot-create_delaunaynetwork_deldir.html | 2 +- .../dot-create_delaunaynetwork_geometry.html | 2 +- ...ot-create_delaunaynetwork_geometry_3d.html | 2 +- .../dot-create_spatialgrid_default_2d.html | 2 +- .../dot-create_spatialgrid_default_3d.html | 2 +- ...dot-create_spatvector_object_from_dfr.html | 2 +- reference/dot-create_terra_spatraster.html | 2 +- reference/dot-do_gpoly.html | 2 +- reference/dot-dt_to_spatvector_points.html | 2 +- reference/dot-dt_to_spatvector_polygon.html | 2 +- reference/dot-edge_coords_array.html | 2 +- reference/dot-filter_network.html | 2 +- reference/dot-find_grid_2d.html | 2 +- reference/dot-find_grid_3d.html | 2 +- reference/dot-find_grid_x.html | 2 +- reference/dot-find_grid_y.html | 2 +- reference/dot-find_grid_z.html | 2 +- reference/dot-fix_multipart_geoms.html | 2 +- reference/dot-giotto_alloc_dt.html | 2 +- ...ot-identify_background_range_polygons.html | 2 +- reference/dot-install_giotto_environment.html | 2 +- reference/dot-install_github_link_pip.html | 2 +- reference/dot-install_py_pkg_reticulate.html | 2 +- reference/dot-merge_spatial_enrich_info.html | 2 +- reference/dot-overlap_points_per_polygon.html | 2 +- ...ot-overlap_points_per_polygon_wrapped.html | 2 +- .../dot-overlap_points_single_polygon.html | 2 +- reference/dot-plot_giottoimage_mg.html | 2 +- reference/dot-plot_giottolargeimage.html | 2 +- reference/dot-print_leaf.html | 2 +- reference/dot-prov_match.html | 2 +- reference/dot-py_install_prompt.html | 2 +- reference/dot-read_cell_metadata.html | 2 +- reference/dot-rescale_polygons.html | 2 +- reference/dot-rotate_spatial_locations.html | 2 +- reference/dot-scale_spatial_locations.html | 2 +- reference/dot-shift_spatial_locations.html | 2 +- reference/dot-shift_spatial_network.html | 2 +- reference/dot-spatraster_sample_values.html | 2 +- reference/dot-spatvector_to_dt.html | 2 +- reference/dot-spline_poly.html | 2 +- reference/dot-subset_giotto.html | 2 +- reference/dot-terra_writeraster_datatype.html | 2 +- reference/edge_distances.html | 2 +- reference/estimateImageBg.html | 2 +- reference/evaluate_input.html | 2 +- reference/exprObj-class.html | 2 +- reference/ext.html | 2 +- reference/fDataDT.html | 2 +- reference/featMetaObj-class.html | 2 +- reference/featType-generic.html | 2 +- reference/featureNetwork-class.html | 2 +- reference/flip.html | 2 +- reference/gefToGiotto.html | 2 +- reference/generate_grid.html | 2 +- reference/getCellMetadata.html | 2 +- reference/getDimReduction.html | 2 +- reference/getExpression.html | 2 +- reference/getFeatureInfo.html | 2 +- reference/getFeatureMetadata.html | 2 +- reference/getGiottoImage.html | 2 +- reference/getMultiomics.html | 42 +++---- reference/getNearestNetwork.html | 2 +- reference/getPolygonInfo.html | 2 +- reference/getSpatialEnrichment.html | 2 +- reference/getSpatialGrid.html | 2 +- reference/getSpatialLocations.html | 2 +- reference/getSpatialNetwork.html | 2 +- reference/get_adj_rescale_img.html | 2 +- reference/get_distance.html | 2 +- reference/get_img_minmax.html | 2 +- reference/get_multiomics.html | 42 +++---- reference/giotto-class.html | 2 +- reference/giottoAffineImage-class.html | 2 +- reference/giottoImage-class.html | 2 +- reference/giottoLargeImage-class.html | 2 +- reference/giottoMasterToSuite.html | 2 +- reference/giottoPoints-class.html | 2 +- reference/giottoPolygon-class.html | 2 +- reference/giottoToAnnData.html | 2 +- reference/giottoToSeurat.html | 2 +- reference/giottoToSeuratV4.html | 2 +- reference/giottoToSeuratV5.html | 2 +- reference/giottoToSpatialData.html | 2 +- reference/giottoToSpatialExperiment.html | 2 +- reference/giotto_instructions.html | 2 +- reference/giotto_python.html | 2 +- reference/hexVertices.html | 2 +- reference/hist.html | 2 +- reference/index.html | 14 ++- reference/init_cell_metadata.html | 2 +- reference/init_feat_metadata.html | 2 +- reference/joinGiottoObjects.html | 2 +- reference/list_cell_id_names.html | 2 +- reference/list_cell_metadata.html | 2 +- reference/list_dim_reductions.html | 2 +- reference/list_dim_reductions_names.html | 2 +- reference/list_expression.html | 2 +- reference/list_expression_names.html | 2 +- reference/list_feat_id_names.html | 2 +- reference/list_feat_metadata.html | 2 +- reference/list_feature_info.html | 2 +- reference/list_feature_info_names.html | 2 +- reference/list_giotto_data.html | 2 +- reference/list_images.html | 2 +- reference/list_images_names.html | 2 +- reference/list_nearest_networks.html | 2 +- reference/list_nearest_networks_names.html | 2 +- reference/list_spatial_enrichments.html | 2 +- reference/list_spatial_enrichments_names.html | 2 +- reference/list_spatial_grids.html | 2 +- reference/list_spatial_grids_names.html | 2 +- reference/list_spatial_info.html | 2 +- reference/list_spatial_info_names.html | 2 +- reference/list_spatial_locations.html | 2 +- reference/list_spatial_locations_names.html | 2 +- reference/list_spatial_networks.html | 2 +- reference/list_spatial_networks_names.html | 2 +- reference/loadGiotto.html | 2 +- reference/makePseudoVisium.html | 2 +- reference/mean_flex.html | 4 +- reference/miscData-class.html | 2 +- reference/my_arowMeans.html | 6 +- reference/my_growMeans.html | 6 +- reference/my_rowMeans.html | 6 +- reference/nnDT_to_kNN.html | 2 +- reference/nnNetObj-class.html | 2 +- reference/objHistory.html | 2 +- reference/objName-generic.html | 2 +- reference/objectlist_name_utils.html | 2 +- reference/ometif_metadata.html | 2 +- reference/ometif_to_tif.html | 2 +- reference/overlapImagesToMatrix.html | 2 +- reference/overlapToMatrix.html | 2 +- reference/overlapToMatrixMultiPoly.html | 2 +- reference/overlaps-generic.html | 2 +- reference/pDataDT.html | 2 +- reference/plot-generic.html | 2 +- reference/plotGiottoImage.html | 2 +- reference/polyStamp-1.png | Bin 15772 -> 15709 bytes reference/polyStamp.html | 2 +- reference/polygon_to_raster.html | 2 +- reference/prov-generic.html | 2 +- reference/r_spatial_conversions.html | 2 +- reference/rbind-generic.html | 2 +- reference/rbind2_giotto_polygon_hetero.html | 2 +- reference/rbind2_giotto_polygon_homo.html | 2 +- reference/readCellMetadata.html | 2 +- reference/readDimReducData.html | 2 +- reference/readExprData.html | 2 +- reference/readExprMatrix.html | 2 +- reference/readFeatData.html | 2 +- reference/readFeatMetadata.html | 2 +- reference/readGiottoInstructions.html | 2 +- reference/readNearestNetData.html | 2 +- reference/readPolygonData.html | 2 +- reference/readSpatEnrichData.html | 2 +- reference/readSpatLocsData.html | 2 +- reference/readSpatNetData.html | 2 +- reference/read_data_params.html | 2 +- reference/reconnect.html | 2 +- reference/reconnectGiottoImage.html | 2 +- reference/reconnect_giottoImage_MG.html | 2 +- reference/reconnect_giottoLargeImage.html | 2 +- reference/reconnect_image_object.html | 2 +- reference/rectVertices.html | 2 +- reference/reexports.html | 2 +- reference/relate.html | 2 +- reference/removeCellAnnotation.html | 2 +- reference/removeFeatAnnotation.html | 2 +- reference/replaceGiottoInstructions.html | 2 +- reference/replace_bracket.html | 2 +- reference/replace_dollar.html | 2 +- reference/rescale.html | 2 +- reference/rescalePolygons.html | 2 +- reference/row-plus-colnames-generic.html | 2 +- reference/rowMeans_flex.html | 6 +- reference/rowSums_flex.html | 6 +- reference/saveGiotto.html | 2 +- reference/setCellMetadata.html | 2 +- reference/setDimReduction.html | 2 +- reference/setExpression.html | 2 +- reference/setFeatureInfo.html | 2 +- reference/setFeatureMetadata.html | 2 +- reference/setGiotto.html | 2 +- reference/setGiottoImage.html | 2 +- reference/setMultiomics.html | 2 +- reference/setNearestNetwork.html | 2 +- reference/setPolygonInfo.html | 2 +- reference/setSpatialEnrichment.html | 2 +- reference/setSpatialGrid.html | 2 +- reference/setSpatialLocations.html | 2 +- reference/setSpatialNetwork.html | 2 +- reference/set_default_feat_type.html | 2 +- reference/set_default_spat_unit.html | 2 +- reference/set_multiomics.html | 2 +- reference/settleGeom,SpatVector-method.html | 8 ++ .../settleGeom,giottoPolygon-method.html | 8 ++ reference/settleGeom-1.png | Bin 0 -> 209312 bytes reference/settleGeom-2.png | Bin 0 -> 169252 bytes reference/settleGeom.html | 103 +++++++++++++++++ reference/seuratToGiotto.html | 2 +- reference/seuratToGiottoV4.html | 2 +- reference/seuratToGiottoV5.html | 2 +- reference/shear.html | 2 +- reference/show.html | 2 +- reference/showGiottoCellMetadata.html | 2 +- reference/showGiottoDimRed.html | 2 +- reference/showGiottoExpression.html | 2 +- reference/showGiottoFeatInfo.html | 2 +- reference/showGiottoFeatMetadata.html | 2 +- reference/showGiottoImageNames.html | 2 +- reference/showGiottoInstructions.html | 2 +- reference/showGiottoNearestNetworks.html | 2 +- reference/showGiottoSpatEnrichments.html | 2 +- reference/showGiottoSpatGrids.html | 2 +- reference/showGiottoSpatLocs.html | 2 +- reference/showGiottoSpatNetworks.html | 2 +- reference/showGiottoSpatialInfo.html | 2 +- reference/showGrids.html | 2 +- reference/showNetworks.html | 2 +- reference/showProcessingSteps.html | 2 +- reference/sliceGiotto.html | 2 +- reference/smoothGiottoPolygons.html | 2 +- reference/spatEnrObj-class.html | 2 +- reference/spatIDs-generic.html | 2 +- reference/spatLocsObj-class.html | 2 +- reference/spatQueryGiottoPolygons.html | 2 +- reference/spatShift.html | 2 +- reference/spatUnit-generic.html | 2 +- reference/spatValues.html | 2 +- reference/spat_net_to_igraph.html | 2 +- reference/spatialExperimentToGiotto.html | 2 +- reference/spatialGridObj-class.html | 2 +- reference/spatialNetworkObj-class.html | 2 +- reference/spatial_binary_ops.html | 2 +- reference/spatialdataToGiotto.html | 2 +- reference/spin.html | 2 +- reference/splitGiotto.html | 2 +- reference/standardise_flex.html | 2 +- reference/stitchFieldCoordinates.html | 2 +- reference/stitchGiottoLargeImage.html | 2 +- reference/stitchTileCoordinates.html | 26 ++--- reference/subsetGiotto.html | 2 +- reference/subsetGiottoLocs.html | 2 +- reference/subsetGiottoLocsMulti.html | 2 +- reference/subsetGiottoLocsSubcellular.html | 2 +- reference/subset_bracket.html | 2 +- reference/subset_dollar.html | 2 +- reference/subset_giotto.html | 2 +- reference/subset_giotto_subobjects.html | 2 +- reference/t_flex.html | 46 ++++---- reference/terraVectData-class.html | 2 +- reference/tessellate.html | 2 +- reference/transpose.html | 2 +- reference/updateGiottoImage.html | 2 +- reference/updateGiottoImageMG.html | 2 +- reference/updateGiottoLargeImage.html | 2 +- reference/updateGiottoObject.html | 2 +- reference/updateGiottoPointsObject.html | 2 +- reference/updateGiottoPolygonObject.html | 2 +- reference/update_giotto_params.html | 2 +- reference/wrap.html | 2 +- reference/writeGiottoLargeImage.html | 2 +- reference/zoom.html | 2 +- search.json | 2 +- sitemap.xml | 2 + 422 files changed, 800 insertions(+), 524 deletions(-) create mode 100644 reference/buffer,giottoPoints-method.html create mode 100644 reference/buffer,giottoPolygon-method.html create mode 100644 reference/buffer,spatLocsObj-method.html create mode 100644 reference/buffer-1.png create mode 100644 reference/buffer.html create mode 100644 reference/settleGeom,SpatVector-method.html create mode 100644 reference/settleGeom,giottoPolygon-method.html create mode 100644 reference/settleGeom-1.png create mode 100644 reference/settleGeom-2.png create mode 100644 reference/settleGeom.html diff --git a/404.html b/404.html index fc190788..e5bf9b22 100644 --- a/404.html +++ b/404.html @@ -22,7 +22,7 @@ GiottoClass - 0.4.0 + 0.4.1 + + + + + +
+
+
+ +
+

Calculate a buffer around all geometries of a SpatVector

+
+ +
+

Usage

+
# S4 method for class 'spatLocsObj'
+buffer(x, width, ..., settle = TRUE)
+
+# S4 method for class 'giottoPoints'
+buffer(x, width, ..., settle = TRUE)
+
+# S4 method for class 'giottoPolygon'
+buffer(x, width, ..., settle = TRUE)
+
+ +
+

Arguments

+ + +
x
+

SpatRaster or SpatVector

+ + +
width
+

numeric. Unit is meter if x has a longitude/latitude CRS, or in the units of the coordinate reference system in other cases (typically also meter). The value should be > 0 if x is a SpatRaster. If x is a SpatVector, this argument is vectorized, meaning that you can provide a different value for each geometry in x; and you can also use the name of a variable in x that has the widths

+ + +
...
+

additional params to pass

+ + +
settle
+

logical. Settle the borders between polygons by cutting them +where they touch based on voronoi boundaries.

+ +
+
+

Value

+

giottoPolygon of buffer polygons

+
+ +
+

Examples

+
sl <- GiottoData::loadSubObjectMini("spatLocsObj")
+slb <- buffer(sl, 30)
+plot(slb)
+
+
+
+
+ + +
+ + + + + + + diff --git a/reference/calculateMetaTable.html b/reference/calculateMetaTable.html index 95010376..3174b4aa 100644 --- a/reference/calculateMetaTable.html +++ b/reference/calculateMetaTable.html @@ -9,7 +9,7 @@ GiottoClass - 0.4.0 + 0.4.1 + + + + + +
+
+
+ +
+

Settle the boundaries between polygons when they overlap by +splitting both at the point where they touch. Works through intersection +with the voronoi of the centroids.

+
+ +
+

Usage

+
# S4 method for class 'giottoPolygon'
+settleGeom(x)
+
+# S4 method for class 'SpatVector'
+settleGeom(x)
+
+ +
+

Arguments

+ + +
x
+

a SpatVector of type "polygons" or object inheriting from +giottoPolygon

+ +
+
+

Value

+

same class as x, with the contained polygons borders settled +in relation to each other.

+
+ +
+

Examples

+
svp <- GiottoData::loadSubObjectMini("giottoPolygon")[]
+svp <- buffer(svp, 5)
+plot(svp)
+
+svp <- settleGeom(svp)
+plot(svp)
+
+
+
+
+ + +
+ + + + + + + diff --git a/reference/seuratToGiotto.html b/reference/seuratToGiotto.html index 04e7eb5f..5435e6cb 100644 --- a/reference/seuratToGiotto.html +++ b/reference/seuratToGiotto.html @@ -9,7 +9,7 @@ GiottoClass - 0.4.0 + 0.4.1