Skip to content

Commit

Permalink
add signac website steps
Browse files Browse the repository at this point in the history
  • Loading branch information
timoast authored Oct 5, 2023
1 parent 8f1da2d commit 30f4f7d
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,36 @@ docker run --name rstudio -v /home/ubuntu/rstudio:/home/rstudio --rm -e PASSWORD
docker run -ti --rm timoast/rstudio R
```

# Building Signac website

The required data is stored at `s3://stuartlab/vignette_data/`:

```
git clone https://github.com/stuart-lab/signac.git
cd signac
mkdir vignette_data
cd vignette_data
# copy vignette data from s3
# this takes a while
aws s3 sync s3://stuartlab/vignette_data/ .
cd ..
# checkout the branch needed
git checkout develop
git pull
# we need to build certain vignettes first so the object is present and updated
Rscript -e "pkgdown::build_article('monocle')"
Rscript -e "pkgdown::build_article('pbmc_multiomic')"
Rscript -e "pkgdown::build_article('mouse_brain_vignette')"
# build the whole site
Rscript -e "pkgdown::build_site()"
```

You might need to set the github PAT, follow instructions from usethis.

# Other tips

The instance type can be changed easily via the AWS console by stopping the instance and then selecting
Expand Down

0 comments on commit 30f4f7d

Please sign in to comment.