satisfying CRAN feedbacks

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ig.degree.betweenness
 Type: Package
-Title: Implementation of "Smith-Pittman" Community Detection Algorithm with a Gradient Evident in Social Partitioning by Smith, Pittman and Xu (2024) for 'igraph' Objects
+Title: "Smith-Pittman Community Detection Algorithm for 'igraph' Objects (2024)"
 Version: 0.1.0
 Authors@R: c(
     person(

R/cluster_degree_betweenness.R

@@ -7,6 +7,7 @@
 #'The function iteratively removes edges based on their betweenness centrality and the degree of their adjacent nodes. At each iteration, it identifies the edge with the highest betweenness centrality among those connected to nodes with the highest degree.It then removes that edge and recalculates the modularity of the resulting graph. The process continues until all edges have been assessed or until no further subgraph can be created with the optimal number of communites being chosen based on maximization of modularity.
 #'
 #' @param graph The graph to analyze
+#' @return An igraph "communities" object with detected communities via the Smith-Pittman algorithm.
 #' @importFrom igraph clusters
 #' @importFrom igraph degree
 #' @importFrom igraph ecount

R/plot_simplified_edgeplot.R

@@ -7,6 +7,7 @@
 #' @param graph igraph object
 #' @param communities optional; A communities object
 #' @param edge.arrow.size edge.arrow size arg. See ?igraph::plot.igraph for more details
+#' @return No return value, called for side effects.
 #' @param ... other arguments to be passed to the \code{plot()} function
 #' @examples
 #'# Load the igraph package

R/prep_unlabeled_graph.R

@@ -3,6 +3,7 @@
 #' Presently, \code{cluster_degree_betweenness()} function only works with labeled graphs. \code{prep_unlabeled_graph()} is a utility function that gives an unlabeled graph labels which are string values of their vertices.
 #'
 #' @param graph an unlabeled graph.
+#' @return An "igraph" object with named vertices.
 #' @seealso [cluster_degree_betweenness()] which this function aids.
 #' @export
 #' @examples

cran-comments.md

@@ -5,4 +5,5 @@
 * Fix in Description with ORCID ID.
 * Fixed title with no period in the end. 
 * Fixed DOI format
-git
+* Added @return values in .R files 
+* Shortened title to 65 Characters