Skip to content

Commit 0950bb5

Browse files
Update README.md
1 parent 5e0f1d9 commit 0950bb5

1 file changed

Lines changed: 4 additions & 22 deletions

File tree

README.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Single-cell Pipeline for End to End Data Integration (SPEEDI) is a fully automat
1616

1717
## Using the SPEEDI Website
1818

19-
We are currently developing a website where users can upload their single cell datasets for processing through SPEEDI and then view and download results. Coming soon!
19+
[SPEEDI Website](https://speedi.princeton.edu/)
20+
21+
The SPEEDI website allows users to upload their single cell datasets to our server for processing. Users can then view and download results once processing completes.
2022

2123
## Running SPEEDI Locally
2224

@@ -28,27 +30,7 @@ if (!requireNamespace("BiocManager", quietly = TRUE)) install.packages("BiocMana
2830
devtools::install_github('FunctionLab/SPEEDI', repos = BiocManager::repositories())
2931
```
3032

31-
All R-related dependencies should be installed automatically. After installing, the easiest way to use SPEEDI is with the `run_SPEEDI()` wrapper function:
32-
33-
```
34-
library(SPEEDI)
35-
# Learn more about the SPEEDI pipeline wrapper function
36-
?run_SPEEDI
37-
# Example parameters for run_SPEEDI - note that some optional parameters
38-
# (metadata_df, reference_file_name, analysis_name, and sample_id_list) were not used
39-
reference_tissue <- "PBMC"
40-
data_type <- "RNA"
41-
species <- "human"
42-
data_path <- "~/test_input"
43-
reference_dir <- "~/references"
44-
output_dir <- "~/test_output"
45-
record_doublets <- FALSE
46-
# Run SPEEDI pipeline
47-
run_SPEEDI(reference_tissue = reference_tissue, data_type = data_type, species = species, data_path = data_path, reference_dir = reference_dir,
48-
output_dir = output_dir, record_doublets = record_doublets)
49-
```
50-
51-
You can also run the individual steps of the pipeline separately. Read through the documentation for `run_SPEEDI()` to learn more!
33+
All R-related dependencies should be installed automatically. To learn how to use SPEEDI, please view the [SPEEDI vignette](https://speedi.princeton.edu/vignette).
5234

5335
## Citing SPEEDI
5436

0 commit comments

Comments
 (0)