Update gscramble2newhybrids.R with @examples and @return

eriqande · Feb 6, 2024 · c79137b · c79137b
1 parent aec7236
commit c79137b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/R/gscramble2newhybrids.R b/R/gscramble2newhybrids.R
@@ -25,7 +25,13 @@
 #' for pivoting, etc.  As such, it is not intended for data sets with
 #' tens of thousands of markers.  You oughtn't be using NewHybrids with
 #' so many markers, anyway!
+#' @return A list with three components:
+#'   - `outfile`: outfile name of saved data.
+#'   - `genos`: Genotypes
+#'   - `allele_names`: Allele names.
 #' @export
+#' @examples
+#' gscramble2newhybrids(M, M_meta)
 gscramble2newhybrids <- function(
     M,
     M_meta,