search

immunogenomics / harmony

Fast, sensitive and accurate integration of single-cell data with Harmony
https://portals.broadinstitute.org/harmony/
Other
529 stars 99 forks source link

do_scatter is defined in the vignette source code but not available #260

Closed MichaelJFlynn closed 2 weeks ago

MichaelJFlynn commented 2 months ago

A new user to Harmony sees the following lines in the vignette as their first exposure to the package:

install.packages('harmony')
library(harmony)
data(cell_lines)
V <- cell_lines$scaled_pcs
meta_data <- cell_lines$meta_data

and then 

p1 <- do_scatter(V, meta_data, 'dataset') + 
    labs(title = 'Colored by dataset')

This last section fails because do_scatter is defined in the source code of the vignette but not available to the new user in the document. This tripped me up for an hour, as I tried to track down some missing package. It would spare time for the new user for that function to be available in the document somewhere.

pati-ni commented 2 weeks ago

Solved! Thanks for your feedback