Prepare first release (#7)

* Add documentation.

* Prepare for release.

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: keedwell
 Title: Latin Squares in R
-Version: 0.0.0.9000
+Version: 0.1.0
 Authors@R: 
     person("Matthew", "Henderson", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-7949-8208"))
@@ -14,4 +14,4 @@ Imports:
   purrr,
   tibble,
   tidygraph,
-  tidyr
+  tidyr

NAMESPACE

@@ -1,2 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export(add_rows)
+export(create_latin_square)
+export(edge_tbl)
+export(next_row)
+export(to_tidygraph)

NEWS.md

@@ -0,0 +1,5 @@
+# keedwell (development version)
+
+# keedwell (v0.1.0)
+
+* Imported functions from mhall-in-r.

R/add-rows.R

@@ -12,10 +12,8 @@
 #' @param R latin rectangle
 #' @param rows empty rows to be filled
 #'
-#' @return
+#' @return A latin rectangle with more rows.
 #' @export
-#'
-#' @examples
 add_rows <- function(R, rows) {
 
   # we assume that the dimension equals

R/create-latin-square.R

@@ -4,12 +4,10 @@
 #' 1 x l_order latin rectangle and then embedding
 #' it in a latin square.
 #'
-#' @param l_order
+#' @param l_order Latin square order.
 #'
-#' @return
+#' @return A latin square.
 #' @export
-#'
-#' @examples
 create_latin_square <- function(l_order) {
   tidyr::expand_grid(row = 1:1, column = 1:l_order) |>
   dplyr::mutate(symbol = 1:l_order) |>

R/edge-tbl.R

@@ -11,10 +11,8 @@
 #' @param i column
 #' @param l_order size of latin square R is going to be embedded into
 #'
-#' @return
+#' @return The edge data frame.
 #' @export
-#'
-#' @examples
 edge_tbl <- function(R, i, l_order = 3) {
 
   all_symbols <- 1:l_order

R/next-row.R

@@ -9,13 +9,11 @@
 #' missing from columns and then find a maximum
 #' matching in that bipartite graph.
 #'
-#' @param R
-#' @param l_order
+#' @param R A latin square
+#' @param l_order The order of the input latin square
 #'
-#' @return
+#' @return A bipartite graph.
 #' @export
-#'
-#' @examples
 next_row <- function(R, l_order) {
   bg <- to_tidygraph(R, l_order)
 

R/to-tidygraph.R

@@ -6,12 +6,11 @@
 #' vertices for columns and symbols and edges representing
 #' symbols missing from columns.
 #'
-#' @param R
+#' @param R A latin rectangle.
+#' @param l_order Order of R.
 #'
-#' @return
+#' @return A bipartite graph.
 #' @export
-#'
-#' @examples
 to_tidygraph <- function(R, l_order = 3) {
 
   ## VERTEX DATA FRAME

keedwell.Rproj

@@ -15,5 +15,6 @@ LaTeX: pdfLaTeX
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace
 
 UseNativePipeOperator: Yes