Tidy up @return text in fn documentation

R/calculate_complexities.R

@@ -22,8 +22,7 @@
 #'
 #' summary(complexities)
 #'
-#' @return `calculate_complexities` returns an object of class
-#' `hagis.complexities`.
+#' @return An object of class `hagis.complexities`.
 #'
 #' An object of class `hagis.complexities` is a `list` containing the following
 #'  components

R/calculate_diversities.R

@@ -54,7 +54,9 @@
 #' diversities
 #'
 #' @export calculate_diversities
-#' @return hagis.diversities object containing
+#' @return a `hagis.diversities` object.
+#' 
+#' A `hagis.diversities` object is a `list` containing:
 #'   * Number of Samples
 #'   * Number of Pathotypes
 #'   * Simple Diversity Index

R/create_binary_matrix.R

@@ -24,8 +24,7 @@
 #'                                     perc_susc = "perc.susc")
 #' final_matrix
 #'
-#' @return `create_binary_matrix` returns a binary matrix of pathotype data as
-#' a [matrix] object
+#' @return a binary matrix of pathotype data
 #' 
 #' @export create_binary_matrix
 #' 

R/summarize_gene.R

@@ -29,7 +29,8 @@
 #'                        perc_susc = "perc.susc")
 #' susc
 #'
-#' @return  returns an object of [class] `hagis.gene.summary`
+#' @return a `hagis.gene.summary` object.
+#' 
 #' An object of class `hagis.gene.summary` is a\cr [data.table::data.table()]
 #'  containing the following components columns
 #'   \describe{

codemeta.json

@@ -249,7 +249,7 @@
   "applicationCategory": "Tools",
   "isPartOf": "https://openplantpathology.org",
   "keywords": ["plant-pathology", "pathotype", "pathogen-survey", "virulenceanalysis", "differentialset", "assessmentscale", "plant-disease", "pathotype-complexities", "population-diversities"],
-  "fileSize": "295.82KB",
+  "fileSize": "295.707KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",