Skip to content

Commit

Permalink
[FIX] - change vignettes to pass BiocCheck (vignettes not remade yet)
Browse files Browse the repository at this point in the history
  • Loading branch information
leopoldguyot committed Apr 23, 2024
1 parent eaa7792 commit e9f67c3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion vignettes/import_section.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ output:
code_folding: show
bibliography: scpGUI.bib
date: "`r BiocStyle::doc_date()`"
package: "`r BiocStyle::pkg_ver('scpGUI')`"
package: "`r BiocStyle::pkg_ver('QFeaturesGUI')`"
vignette: >
%\VignetteIndexEntry{Import Section}
%\VignetteEngine{knitr::rmarkdown}
Expand Down
18 changes: 10 additions & 8 deletions vignettes/scpGUI.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ output:
code_folding: show
bibliography: scpGUI.bib
date: "`r BiocStyle::doc_date()`"
package: "`r BiocStyle::pkg_ver('scpGUI')`"
package: "`r BiocStyle::pkg_ver('QFeaturesGUI')`"
vignette: >
%\VignetteIndexEntry{scpGUI}
%\VignetteIndexEntry{QFeaturesGUI}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
Expand All @@ -26,6 +26,11 @@ knitr::opts_chunk$set(
)
```


WIP



# scpGUI

`scpGUI` is a shiny application that serves as a graphical interface for the [`scp` package](https://bioconductor.org/packages/release/bioc/html/scp.html) (@scpVanderaa). It leverages the power of Shiny and ShinydashboardPlus to provide a user-friendly interface for SCP data analysis. The app is organized into multiple sections, each dedicated to a specific aspect of SCP data processing. These sections are documented in separate vignettes to make it easy for users to navigate and find information relevant to their needs.
Expand All @@ -52,9 +57,9 @@ if (!require("remotes", quietly = TRUE)) {
install.packages("remotes")
}
# Install the package
remotes::install_github("UCLouvain-CBIO/scpGUI")
#remotes::install_github("UCLouvain-CBIO/scpGUI")
# Load the package
library(scpGUI)
#library(scpGUI)
```

## Application launch
Expand All @@ -72,12 +77,9 @@ if (interactive()) {
When launching `scpGUI`, the user can see section of the app on the right sidebar. Each section will serve one step of the workflow.
Each section is documented in its own vignette:

- [Import Section](https://uclouvain-cbio.github.io/scpGUI/articles/import_section.html)

# Citation

```{r citation}
citation("scpGUI")
```


# References

0 comments on commit e9f67c3

Please sign in to comment.