Skip to content

Commit

Permalink
Update pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
keller-mark committed Oct 2, 2023
1 parent 4d6cf3b commit d340050
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
12 changes: 3 additions & 9 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,13 @@ reference:
desc: "Wrapper classes for automating the data conversion process for Vitessce."
- contents:
- AbstractWrapper
- SeuratWrapper
- SCEWrapper
- SPEWrapper
- GiottoWrapper
- AnnDataWrapper
- CsvWrapper
- MultiImageWrapper
- OmeTiffWrapper
- OmeZarrWrapper

articles:
- title: Articles
navbar: Developer guides
contents:
- dev_wrapper_class
- dev_wrapper_subclass
- title: Articles
navbar: Troubleshooting
contents:
Expand Down
13 changes: 1 addition & 12 deletions vignettes/debugging.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,9 @@ The following code snippets assume that `vitessceR` has been loaded via `library

```r
library(vitessceR)
vc <- VitessceConfig$new("My single-cell data visualization")
vc <- VitessceConfig$new(schema_version = "1.0.16", name = "My single-cell data visualization")
```

## Use the `out_dir` parameter for data object wrapper classes

Rather than using a temporary directory, this will write converted files to the specified directory.
This way, you can open and explore the converted output files.

```r
dir.create("./debug")

dataset <- vc$add_dataset("My dataset")
dataset <- dataset$add_object(SeuratWrapper$new(pbmc3k.final, out_dir = "./debug"))
```

## Use the `port` parameter

Expand Down

0 comments on commit d340050

Please sign in to comment.