fixup help and description

Author: JohnMount

DESCRIPTION

@@ -1,12 +1,12 @@
 Package: cdata
 Type: Package
-Title: Wrappers for tidyr::gather() and tidyr::spread()
+Title: Wrappers for 'tidyr::gather()' and 'tidyr::spread()'
 Version: 0.1.0
 Author: John Mount, Nina Zumel
 Maintainer: John Mount <[email protected]>
 URL: https://github.com/WinVector/cdata
 BugReports: https://github.com/WinVector/cdata/issues
-Description: Supplies deliberately verbose wrappers for tidyr::gather() and tidyr::spread(), and an explanatory vignette.  Useful for training and for enforcing preconditions.
+Description: Supplies deliberately verbose wrappers for 'tidyr::gather()' and 'tidyr::spread()', and an explanatory vignette.  Useful for training and for enforcing preconditions.
 License: GPL-3
 Encoding: UTF-8
 LazyData: true

R/RowsColumns.R

@@ -12,6 +12,7 @@ NULL
 #' @param allowNAKeys logical if FALSE throw if there are NAs in the key columns.
 #' @return logical TRUE if the rows of data are unique addressable by the columns named in keyColNames.
 #'
+#'
 #' @examples
 #'
 #' d <- data.frame(key= c('a','a', 'b'))
@@ -58,7 +59,9 @@ checkColsFormUniqueKeys <- function(data, keyColNames,
 
 #' Move values from columns to rows (wrapper for \code{tidyr::gather}, or anti-pivot).
 #'
+#' For a tutorial please try \code{vignette('RowsAndColumns', package='cdata')}.
 #'
+#' @seealso \code{\link{moveValuesToColumns}}
 #'
 #' @param data data.frame to work with.
 #' @param nameForNewKeyColumn character name of column to write new keys in.
@@ -142,6 +145,10 @@ moveValuesToRows <- function(data,
 
 #' Move values from rows to columns (wrapper for \code{tidyr::spread} or pivot).
 #'
+#' For a tutorial please try \code{vignette('RowsAndColumns', package='cdata')}.
+#'
+#' @seealso \code{\link{moveValuesToRows}}
+#'
 #' @param data data.frame to work with.
 #' @param columnToTakeKeysFrom character name of column build new column names from.
 #' @param columnToTakeValuesFrom character name of column to get values from.

R/package.R

@@ -1,4 +1,4 @@
-#' \code{cdata}d: Wrappers for \code{tidyr::gather()} and \code{tidyr::spread()}
+#' \code{cdata}: Wrappers for \code{tidyr::gather()} and \code{tidyr::spread()}
 #'
 #' cdata supplies deliberately verbose wrappers for \code{tidyr::gather()} and \code{tidyr::spread()}, and an explanatory vignette.
 #' Useful for training and for enforcing preconditions.