Skip to content

Commit

Permalink
work on loadFry doc
Browse files Browse the repository at this point in the history
  • Loading branch information
an-altosian committed Jan 1, 2025
1 parent 77246ee commit d7e3424
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 7 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ biocViews: Sequencing, RNASeq, GeneExpression,
AlternativeSplicing, SingleCell
VignetteBuilder: knitr
LazyData: true
RoxygenNote: 7.2.3
RoxygenNote: 7.3.2
8 changes: 4 additions & 4 deletions R/alevin-loadFry.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
#' The first column is assumed to be the barcodes and is named as "barcodes".
#' Extra auxiliary columns in the barcodes file without a specified name will be ignored.
#' @param gene_id_to_name path to a file that contains the mapping from gene names to gene ids.
#' It is only needed if
#' 1. you are not using the simpleaf pipeline (`simpleaf index` + `simpleaf quant`), \\
#' 2. you have such a file, and, \\
#' 3. you want to add this information to the coldata of your anndata. \\
#' It is only needed if\cr
#' 1. you are not using the simpleaf pipeline (`simpleaf index` + `simpleaf quant`),\cr
#' 2. you have such a file, and,\cr
#' 3. you want to add this information to the colData of your output object.\cr
#' If you do, please ensure it is a tab-separated, two-column file without a header, and the first column is the gene ids and the second column is the gene names.
#' @param nonzero whether to filter cells with non-zero expression
#' value across all genes (default \code{FALSE}).
Expand Down
34 changes: 34 additions & 0 deletions man/fishpond-package.Rd

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

23 changes: 21 additions & 2 deletions man/loadFry.Rd

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

0 comments on commit d7e3424

Please sign in to comment.