CenterForOpenScience / modular-file-renderer

A Python package for rendering files to HTML via an embeddable iframe
http://modular-file-renderer.readthedocs.io/en/latest/
Apache License 2.0
44 stars 67 forks source link

[SVCS-549] Added jamovi renderer #279

Closed jonathon-love closed 7 years ago

jonathon-love commented 7 years ago

hi,

[from a code review perspective] this is more or less the same as the jasp renderer (which i also wrote). both the .jasp and the .omv file formats are very similar (again, both designed by me), however, we are expecting the jamovi file format to diverge from the .jasp format in the future -- which is why i haven't elected to unify them.

with thanks

felliott commented 7 years ago

Thanks @jonathon-love! We'll be reviewing the new MFR renderers in the near future and will take a look at this. One thing, could you add a README with some information about the jamovi format? Purpose, what software uses it, links to a spec (if available), that sort of thing. It's helpful when dealing with more specialized file types. Also, you'll need to add an extension => renderer mapping to setup.py, so that MFR will know how to handle jamovi files.

Cheers, @felliott

jonathon-love commented 7 years ago

hi @felliott,

can you give me a bit more information about the README. i was hoping there would be an extension with a README which i could use as a model, but none of the existing extensions seem to provide one.

i'll do my best to put one together

with thanks

felliott commented 7 years ago

Hey @jonathon-love! What you have there is perfect. I just want a guide for newer and less-common file formats, to help orient new devs. Thanks!

cslzchen commented 7 years ago

@jonathon-love Can you also add [SVCS-549] in front of the title of the PR? Thanks.

cslzchen commented 7 years ago

Ticket

https://openscience.atlassian.net/browse/SVCS-549

jonathon-love commented 7 years ago

OK, should be good to go

felliott commented 7 years ago

After fixing the javascript in attributes issue, this is good to go.

jonathon-love commented 7 years ago

OK, is there anything else you're waiting on, or is this in the queue?

with thanks

felliott commented 7 years ago

It's in the queue, should be merged within the next week.

felliott commented 7 years ago

Looks good, merging.

jonathon-love commented 7 years ago

great! how long does it typically take to go live at osf.io?

with thanks

felliott commented 7 years ago

Hey @jonathon-love,

I'm not entirely sure. Normally it would be pretty fast, but we've got a holiday week coming up here in the states that making planning tricky. I'll ping here when I've got an estimate.

Cheers, Fitz

jonathon-love commented 6 years ago

sooooo, still no estimate?

with thanks

felliott commented 6 years ago

Nope! We've only got two tickets left to QA, but our QA interns are gone for the holidays. It should be soon after the next OSF release, so keep an eye out for that.

felliott commented 6 years ago

Hey @jonathon-love,

Sorry for forgetting to update you! Your jamovi-rendering PR was included in MFR v0.23 and released on 2018-01-19.

Cheers, Fitz

jonathon-love commented 6 years ago

awesome! thanks very much!

jonathon

jonathon-love commented 6 years ago

although, i'm not having heaps of success. hopefully just a temporary outage of some sort.

screen shot 2018-01-25 at 14 42 02
felliott commented 6 years ago

Huh. That's no good. I'll take a look.

felliott commented 6 years ago

The renderer is looking for a file called 01%20anova/resources/7248b84f2576b751.png in the zip archive. How is the top-level folder encoded if you unzip the archive?

jonathon-love commented 6 years ago
$ unzip -l ping.omv
Archive:  ping.omv
  Length      Date    Time    Name
---------  ---------- -----   ----
    14167  11-15-2017 08:28   index.html
       97  11-15-2017 08:28   META-INF/MANIFEST.MF
     1257  11-15-2017 08:28   metadata.json
      422  11-15-2017 08:28   xdata.json
     4836  11-15-2017 08:28   data.bin
     6529  11-15-2017 08:28   01 anova/analysis
        0  11-15-2017 08:27   ./
    36376  11-15-2017 08:28   01 anova/resources/7248b84f2576b751.png
---------                     -------
    63684                     8 files
jonathon-love commented 6 years ago

https://osf.io/gw3k5/

jonathon-love commented 6 years ago

i'm looking into it (just figuring out how to run mfr locally again, been a while).

jonathon-love commented 6 years ago

chuckles, this is my cock-up. any jamovi files with images in them won't work :/

will have a PR for you shortly.