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

Initial installation of Scaffold in R #2

Open
Nyaradzo opened this issue Mar 16, 2017 · 13 comments
Open

Initial installation of Scaffold in R #2

Nyaradzo opened this issue Mar 16, 2017 · 13 comments

Comments

@Nyaradzo
Copy link

Hello,

I am struggling to get started with using scaffold in R. I have been able to load all the packages but when i get to loading my files nothing happens. I get the NULL response in R studio and I cannot choose a dataset or anything on the page in the browser.
Can you help?

Nyari

@vjcitn
Copy link
Collaborator

vjcitn commented Mar 16, 2017

I am not a developer of this code but I am commenting as an interested party.

I would agree that the README, while strong on installation concepts, does not really take a new user through the steps required to have a successful first run. You are using Rstudio. Thus when you start run.scaffold(), a browser window to drive the analysis will open, but also, a widget will pop up asking you to pick a file. Implicitly you must pick a file that has .fcs as suffix. In the browser interface, you are asked in the README to select "Run clustering". Given that you have chosen an FCS file, the "Run clustering" panel will have dropdowns with options for file choice, marker choice, and clustering options. Certain defaults are provided. I used an FCS file from flowCore: R RHOME/library/flowCore/extdata/0877408774.B08 ... it must be renamed to have a .fcs suffix to be identified in scaffold. It is taking forever to cluster on the markers I chose, so I think I must have done something wrong. It would be good for the developers to supply a test dataset where "answers" are clear for certain selections of tuning parameters.

@SamGG
Copy link

SamGG commented Mar 16, 2017

I am developing this neither, but testing Scaffold is in my todo list.

I fully agree that a small set of FCS files would allow one to test the installation and the concept. FCS files usually end with a ".fcs" extension. Nolan lab is mainly working with latest CyTOF instrument whereas flowCore demo files were acquired a decade ago or so.

One must select a FCS file in order to inform the software about the location of the folder that contains the FCS files to process (using shinyFiles library sounds a better option IMHO, https://cran.r-project.org/web/packages/shinyFiles). In order to restart a shiny app, press the red STOP of the R console.

To reproduce/accelerate Vince's test, select FL[1234]-H channels only, ask for 20 clusters instead of 200, set arcsinh to 150 or 500 rather than 5 (150 is for fluorescent cytometry and stated later in the README), and run (I don't know what "samples" means, may be "runs" ie repetitions). Within a few minutes you get text files as results. Unfortunately, I get stuck in constructing a SCAFFoLD map.

HTH

> scaffold.run()

Listening on http://127.0.0.1:4659
NULL
[1] "Performing clara clustering"
[1] "Clustering done"
[1] "Performing clara clustering"
[1] "Clustering done"
[1] "Performing clara clustering"
[1] "Clustering done"
[1] "Markers used for SCAFFoLD: FL1-H, FL2-H, FL3-H, FL4-H"
[1] "Using as reference 0877408774.B08.fcs.clustered.txt"
[1] "Downsampling to 1000 events"
Warning: Error in <-: attempt to set an attribute on NULL
Stack trace (innermost first):
    89: load_attractors_from_gated_data
    88: scaffold:::run_analysis_gated
    81: isolate
    80: renderText [C:\Users\samgg\Documents\R\win-library\3.3\scaffold\shinyGUI/server.R#352]
    79: func
    78: origRenderFunc
    77: output$analysisui_empty
     2: runApp
     1: scaffold.run

Characteristics of demo files.

flowFrame object '0877408774.B08'
with 10000 cells and 8 observables:
     name              desc range minRange maxRange
$P1 FSC-H             FSC-H  1024        0     1023
$P2 SSC-H             SSC-H  1024        0     1023
$P3 FL1-H              <NA>  1024        0     1023
$P4 FL2-H              <NA>  1024        0     1023
$P5 FL3-H              <NA>  1024        0     1023
$P6 FL1-A              <NA>  1024        0     1023
$P7 FL4-H              <NA>  1024        0     1023
$P8  Time Time (51.20 sec.)  1024        0     1023
149 keywords are stored in the 'description' slot

Archive with FCS files and clustering results
scaffold-demo.zip

@zinagood
Copy link
Collaborator

zinagood commented Mar 17, 2017 via email

@Nyaradzo
Copy link
Author

Nyaradzo commented Mar 22, 2017 via email

@vjcitn
Copy link
Collaborator

vjcitn commented Mar 22, 2017 via email

@DMrdjen
Copy link

DMrdjen commented Mar 30, 2017

Hey guys, How can I export pdf's of the scaffold maps?

@davemcilwain
Copy link

davemcilwain commented Mar 30, 2017 via email

@DMrdjen
Copy link

DMrdjen commented Mar 30, 2017 via email

@DMrdjen
Copy link

DMrdjen commented May 22, 2017

Is it possible to plot single cells instead of clustered nodes, in points rather than in bubbles?

@zinagood
Copy link
Collaborator

zinagood commented May 22, 2017 via email

@Nemo2013
Copy link

Hi there,
This is the first time I am using scaffold. I have got the .Rdata files and am trying to run the scaffold analysis as in the README. I keep getting an error "missing value where TRUE/FALSE needed". I have tried filling in different combinations of things in the drop down menu/tick boxes but still get this error. I have my gated fcs files in a subdirectory "gated"...

This is the print out I get in R studio -
tack trace (innermost first):
89: load_attractors_from_gated_data
88: scaffold:::run_analysis_gated
81: isolate
80: renderText [/Library/Frameworks/R.framework/Versions/3.3/Resources/library/scaffold/shinyGUI/server.R#352]
79: func
78: origRenderFunc
77: output$analysisui_empty
2: runApp
1: scaffold.run

Any suggestions where I am missing this TRUE/FALSE value?

Thanks very much.
Kirsten

@mvetill
Copy link

mvetill commented Sep 28, 2017

Hi !
I'm also experiencing problem to lunch scaffold since the installation went well, the select file window popup as well as the browser, but when I choose a FCS file from a fcs file folder nothing happen.

library(scaffold)
scaffold.run()

Listening on http://127.0.0.1:5732

here windows popup normally and I choose a FCS file

ERROR: [on_request_read] connection reset by peer

please Help :)
Regards!!

@SamGG
Copy link

SamGG commented Sep 28, 2017

Hi!
@mvetill I think you should open a new issue and tell the computer OS, the web browser, the R version and any message that appeared in the console. A Google search points to many causes, but you should try to use Firefox or Chrome if you are not.
HTH

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants