From d02441550ec0df596db2432652adccc13aca21bb Mon Sep 17 00:00:00 2001 From: Chananchida Sang-aram VSCODE Date: Tue, 19 Sep 2023 11:22:23 +0200 Subject: [PATCH] minor documentation changes --- R/Seurat.R | 6 +----- man/Seurat.Rd | 5 ++--- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/R/Seurat.R b/R/Seurat.R index 694f605d..cc8bc76f 100644 --- a/R/Seurat.R +++ b/R/Seurat.R @@ -109,9 +109,8 @@ to_Seurat <- function(obj) { # nolint #' @param seurat_obj An object inheriting from Seurat. #' @param output_class Name of the AnnData class. Must be one of `"HDF5AnnData"` or `"InMemoryAnnData"`. #' @param assay Assay to be converted. If NULL, `DefaultAssay()` is used. -#' @param X Which of 'counts', 'data', or 'scale.data' will be used for X. By default, 'counts' will be used (if it is not empty', followed by 'data', then 'scale.data'. The remaining non-empty slots will be stored in different layers. +#' @param X Which of 'counts', 'data', or 'scale.data' will be used for X. By default, 'counts' will be used (if it is not empty), followed by 'data', then 'scale.data'. The remaining non-empty slots will be stored in different layers. #' @param ... Additional arguments passed to the generator function. -#' See the "Details" section for more information on which parameters #' #' @export # TODO: add tests with Seurat objects not created by anndataR @@ -173,9 +172,6 @@ from_Seurat <- function(seurat_obj, output_class = c("InMemoryAnnData", "HDF5Ann ... ) - # trackstatus: class=Seurat, feature=set_X, status=wip - # trackstatus: class=Seurat, feature=set_layers, status=wip - if (!is.null(X)) { slots_priority <- c("counts", "data", "scale.data") diff --git a/man/Seurat.Rd b/man/Seurat.Rd index 984aa12c..c8373de1 100644 --- a/man/Seurat.Rd +++ b/man/Seurat.Rd @@ -24,10 +24,9 @@ from_Seurat( \item{assay}{Assay to be converted. If NULL, \code{DefaultAssay()} is used.} -\item{X}{Which of 'counts', 'data', or 'scale.data' will be used for X. By default, 'counts' will be used (if it is not empty', followed by 'data', then 'scale.data'. The remaining non-empty slots will be stored in different layers.} +\item{X}{Which of 'counts', 'data', or 'scale.data' will be used for X. By default, 'counts' will be used (if it is not empty), followed by 'data', then 'scale.data'. The remaining non-empty slots will be stored in different layers.} -\item{...}{Additional arguments passed to the generator function. -See the "Details" section for more information on which parameters} +\item{...}{Additional arguments passed to the generator function.} } \description{ \code{to_Seurat()} converts an AnnData object to a Seurat object.