Skip to content

Commit

Permalink
Fix docs (#58)
Browse files Browse the repository at this point in the history
* Rerender documentation

* Update to recommended format for package documentation

* Version bump
  • Loading branch information
csoneson authored Mar 27, 2024
1 parent b14d858 commit 853cbfb
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 27 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: iSEEindex
Title: iSEE extension for a landing page to a custom collection of data sets
Version: 1.1.1
Version: 1.1.2
Date: 2024-02-21
Authors@R:
c(person("Kevin", "Rue-Albrecht", email = "[email protected]",
Expand All @@ -25,7 +25,7 @@ biocViews: Software,
Infrastructure
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
Depends:
SummarizedExperiment,
SingleCellExperiment
Expand Down
7 changes: 3 additions & 4 deletions R/iSEEindex-pkg.R → R/iSEEindex-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' single iSEE web-application.
#' The main functionality of this package is to define a custom landing page
#' allowing app maintainers to list a custom collection of data sets that users
#' can selected from and directly load objects into an iSEE web-application.
#' can select from and directly load objects into an iSEE web-application.
#'
#' @seealso
#' Useful links:
Expand All @@ -13,6 +13,5 @@
#' - Report bugs at <https://support.bioconductor.org/t/iSEEindex>
#'
#' @keywords internal
#' @name iSEEindex-pkg
#' @docType package
NULL
#' @aliases iSEEindex-package NULL
"_PACKAGE"
36 changes: 36 additions & 0 deletions man/iSEEindex-package.Rd

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

21 changes: 0 additions & 21 deletions man/iSEEindex-pkg.Rd

This file was deleted.

5 changes: 5 additions & 0 deletions man/iSEEindex.Rd

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

0 comments on commit 853cbfb

Please sign in to comment.