Skip to content

Commit

Permalink
minor documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
csangara committed Sep 19, 2023
1 parent c4e5259 commit d024415
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
6 changes: 1 addition & 5 deletions R/Seurat.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 112 in R/Seurat.R

View workflow job for this annotation

GitHub Actions / lint

file=R/Seurat.R,line=112,col=121,[line_length_linter] Lines should not be more than 120 characters.
#' @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
Expand Down Expand Up @@ -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")

Expand Down
5 changes: 2 additions & 3 deletions man/Seurat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d024415

Please sign in to comment.