Skip to content

Commit

Permalink
Made note to remove 'practical' vignette from package for cran.
Browse files Browse the repository at this point in the history
  • Loading branch information
pcarbo committed Jul 8, 2024
1 parent bf96397 commit 8a9de99
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Encoding: UTF-8
Type: Package
Package: fastTopics
Version: 0.6-189
Date: 2024-07-07
Version: 0.6-190
Date: 2024-07-08
Title: Fast Algorithms for Fitting Topic Models and Non-Negative
Matrix Factorizations to Count Data
Authors@R: c(person("Peter","Carbonetto",role=c("aut","cre"),
Expand Down
2 changes: 1 addition & 1 deletion R/fit_poisson_nmf.R
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ fit_poisson_nmf <- function (X, k, fit0, numiter = 100,
cat(sprintf("Running at most %d %s updates, %s extrapolation ",
numiter,method.text,
ifelse(control$extrapolate,"with","without")))
cat("(fastTopics 0.6-189).\n")
cat("(fastTopics 0.6-190).\n")
}

# INITIALIZE ESTIMATES
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ See the [package documentation][pkgdown] for more information.

## Developer notes

To prepare the package for CRAN, remove the "Remotes" field in the
DESCRIPTION file, and set `on_cran <- TRUE` in `helper_functions.R`,
then run `R CMD build fastTopics` to build the source package.
To prepare the package for CRAN, remove the
"single_cell_rnaseq_practical" vignette, then run `R CMD build
fastTopics` to build the source package.

This is the command used to check the package before submitting to
CRAN:
Expand Down
5 changes: 4 additions & 1 deletion vignettes/single_cell_rnaseq_basic.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ The aim of this vignette is to introduce the basic concepts behind an
analysis of single-cell RNA-seq data using a topic model, and to show
how to use 'fastTopics' to implement this analysis. This first
vignette explains the analysis steps at only a high level---see
[Part 2][vignette-part-2] for additional explanations and guidance.
[Part 2][vignette-part-2] for additional explanations and
guidance. (Note that Part 2 was not included with the fastTopics
package on CRAN. It is only included with the fastTopics package on
GitHub.)

Since a topic model analysis is quite different from most conventional
analyses of single-cell RNA-seq data, we point out key
Expand Down

0 comments on commit 8a9de99

Please sign in to comment.