npiccolotto / tbss-vis

Visual Analytics for Temporal Blind Source Separation
GNU General Public License v3.0
4 stars 0 forks source link

Should there be HTML output? #2

Open Iowastater opened 1 year ago

Iowastater commented 1 year ago

My supposition was that running the code would generate a dashboard such as is shown in the paper "TBSSvis--Visual-analytics-for-Temporal-Blind-Source" from Sep_2022 in the Visual Informatics journal.

In my experience - R calculations can all be run successfully - is the output supposed to appear as HTML using something called Swagger docs? It is unclear (to me) from the documentation - what is supposed to occur with the Swagger docs link that is generated by the R/plumber combination?

"Try it Out"

There is a link generated, when you go the Swagger docs website, the pages and use the "try it out" button, nothing happens. Should something happen?

"Download"

There is a "download" button. Nothing happens when it is clicked. Should something happen?

image

npiccolotto commented 1 year ago

Hi,

the Swagger docs are automatically created by plumber, which is the backend web server that provides data to the client. You don't need to care about Swagger.

The web client, i.e., the HTML you are looking for, you can find in the folder dist_local of the project. You use it by serving it with any web server (so there are two web servers on your machine running — one for the backend, one for the client): Apache2, nginx, or any other. A popular simple way I can recommend is using the built-in web server of Python:

cd [path to project]/dist_local
python3 -m http.server 8000

If the above commands are successful, you can access the client at http://localhost:8000.

Hope this helps!

Iowastater commented 1 year ago

Tried to follow this suggestion - "The web client, i.e., the HTML you are looking for, you can find in the folder dist_local of the project."

I looked up the path used in the RStudio terminal image

In order to follow this command "cd [path to project]/dist_local", I was expecting that the file would be dated today, 9/5/23 because I just ran the api.R script successfully. image

Seems incorrect that the date on "local_host" would be 8/4/23. Makes me wonder if today's "dist_local" file was written to a location other than the path used in the RStudio terminal. image

Assuming that the dist-local folder location has been successfully identified, try to follow the command

cd [path to project]/dist_local

This appears to be a command line, and the instructions say that Python will be used to run the HTML file. Is this command supposed to run in a new command line window? Or is it supposed to be run within Python? Or even within the terminal window back from RStudio? image

image

image