Skip to content

Commit

Permalink
Update help text for mixed data types.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlmelville committed Dec 6, 2018
1 parent 157abba commit d1fb38d
Show file tree
Hide file tree
Showing 6 changed files with 318 additions and 111 deletions.
9 changes: 8 additions & 1 deletion R/transform.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@
#' Carry out an embedding of new data using an existing embedding. Requires
#' using the result of calling \code{\link{umap}} or \code{\link{tumap}} with
#' \code{ret_model = TRUE}.
#'
#'
#' Note that some settings are incompatible with the production of a UMAP model
#' via \code{\link{umap}}: external neighbor data (passed via a list to the
#' argument of the \code{nn_method} parameter), and factor columns that were
#' included in the UMAP calculation via the \code{metric} parameter. In the
#' latter case, the model produced is based only on the numeric data.
#' A transformation is possible, but factor columns in the new data are ignored.
#'
#' @param X The new data to be transformed, either a matrix of data frame. Must
#' have the same columns in the same order as the input data used to generate
#' the \code{model}.
Expand Down
Loading

0 comments on commit d1fb38d

Please sign in to comment.