Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added FAQs for sctk web app in the doc #701

Merged
merged 1 commit into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,10 @@ navbar:
href: articles/visualization.html
- text: "Generic Heatmap"
href: articles/heatmap.html
- text: "Web Application"
menu:
- text: "FAQs"
href: articles/webApp.html
- text: "Reference"
href: reference/index.html
- text: "NEWS"
Expand Down
41 changes: 41 additions & 0 deletions vignettes/articles/webApp.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "SCTK Web Application"
author: "Irzam Sarfraz"
output:
html_document:
toc: true
toc_depth: 5
bibliography: references.bib
csl: ieee.csl
---

```{r develSetting, include=FALSE}
knitr::opts_chunk$set(warning = FALSE)
```

## Quick Links:
- [Go to SCTK web-app](https://sctk.bu.edu/)
- [How to import and upload data?](import_data.html)
- [How to export and save data?](export_data.html)

## Common FAQs for the SCTK app:

**1. What is the maximum data size you can upload to the web-application?**

The maximum data upload size is 1GB.

**2. Can you login and store your data?**

Currently users are not able to create a unique login and store their data on the SCTK server.

**3. How to save your progress?**

Go to the “Data” tab, click on “Export Single Cell Data” and download the RDS object. The RDS file will contain a SingleCellExperiment object with your single cell data and results.

**4. How to continue analysis starting from previously saved data?**

Go to the “Data” tab, click on “Import Single Cell Data”, select the “Upload SingleCellExperiment or Seurat object stored in an RDS File” option, and click “Add to sample list” to upload the previously saved RDS object containing the SingleCellExperiment.

**5. How to generate HTML reports for reproducible analysis?**

Tables and figures can be exported when generated in the user-interface but at this time, reports cannot be generated through the interface and we are working towards adding the ability to generate reports through it.