Chore: documentation #157
Merged
Chore: documentation #157
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
jiajic
commented
Jan 10, 2024
jiajic
commented
- update createSpatialNetwork docs
- add vignetteBuilder info to image_tools vignette
- update createSpatialNetwork docs - add vignetteBuilder info to image_tools vignette
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| #' @param maximum_distance distance cuttof for Delaunay neighbors to consider. If "auto", "upper wisker" value of the distance vector between neighbors is used; see the boxplot{graphics} documentation for more details.(default = "auto") | ||
| #' @param minimum_k minimum number of neigbhours if maximum_distance != NULL | ||
| #' @param options (geometry) String containing extra control options for the underlying Qhull command; see the Qhull documentation (../doc/qhull/html/qdelaun.html) for the available options. (default = 'Pp', do not report precision problems) | ||
| #' @param maximum_distance distance cuttof for Delaunay neighbors to consider. If "auto", "upper whisker" value of the distance vector between neighbors is used; see the boxplot{graphics} documentation for more details.(default = "auto") |
Check notice
Code scanning / lintr
Lines should not be more than 80 characters. This line is 237 characters. Note
| #' @param options (geometry) String containing extra control options for the underlying Qhull command; see the Qhull documentation (../doc/qhull/html/qdelaun.html) for the available options. (default = 'Pp', do not report precision problems) | ||
| #' @param maximum_distance distance cuttof for Delaunay neighbors to consider. If "auto", "upper whisker" value of the distance vector between neighbors is used; see the boxplot{graphics} documentation for more details.(default = "auto") | ||
| #' @param minimum_k minimum number of neighbours if maximum_distance != NULL | ||
| #' @param options (geometry) String containing extra control options for the underlying Qhull command; see the [Qhull documentation](http://www.qhull.org/html/qdelaun.htm) for the available options. (default = 'Pp', do not report precision problems) |
Check notice
Code scanning / lintr
Lines should not be more than 80 characters. This line is 249 characters. Note
| #' @name createSpatialNetwork | ||
| #' @description Create a spatial network based on cell centroid physical distances. | ||
| #' @description Create a spatial network based on cell centroids. These networks | ||
| #' are often used when determining cell-cell connectivities and spatial relationships. |
Check notice
Code scanning / lintr
Lines should not be more than 80 characters. This line is 86 characters. Note
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.