openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
720 stars 38 forks source link

[PRE REVIEW]: Tool assisted game equilibrium design (TAGED) #5800

Closed editorialbot closed 10 months ago

editorialbot commented 1 year ago

Submitting author: !--author-handle-->@MickaelMartinNevot<!--end-author-handle-- (Mickaël Martin Nevot) Repository: https://github.com/FraDiavolo7/TAGED Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: George K. Thiruvathukal

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0"><img src="https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0/status.svg)](https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0)

Author instructions

Thanks for submitting your paper to JOSS @MickaelMartinNevot. Currently, there isn't a JOSS editor assigned to your paper.

@MickaelMartinNevot if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
editorialbot commented 1 year ago

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf
editorialbot commented 1 year ago

:warning: An error happened when generating the pdf.

editorialbot commented 1 year ago
Software report:

github.com/AlDanial/cloc v 1.88  T=70.02 s (892.5 files/s, 170003.6 lines/s)
---------------------------------------------------------------------------------------
Language                             files          blank        comment           code
---------------------------------------------------------------------------------------
HTML                                 22086         135909          30185        3327323
C/C++ Header                         16565         445229         483471        2365595
SQL                                     11            880            750        1588083
C++                                  16875         306978         255241        1538706
XML                                   1103          94406           4684         336551
JSON                                   883           2170              0         272922
SVG                                    856            336           1572         163599
JavaScript                             639           3217           3534          94964
AsciiDoc                               165          12685           1359          39772
MSBuild script                         130              1              7          34791
C                                       81           6081           8762          33514
reStructuredText                       459          17598          16634          28036
TeX                                    192           9168            391          24300
CSS                                     85           4567           2344          21773
Markdown                               570           6956             10          17566
Python                                 377           6800          15150          15240
XSLT                                    68           1933           1612          14474
CMake                                  417           4347           3391          13534
PHP                                    108           2614           4475           9778
Jam                                    315           1740           3042           7721
Bourne Shell                           135           1551           1523           7465
Assembly                                98           2255           7187           6756
CUDA                                    25            369            352           3256
C#                                      22            342           1038           2998
Ada                                     10            599            560           1681
D                                       21             14              8           1663
make                                    30            422            182           1373
Perl                                    16            248            331           1265
Pascal                                   5            219            551           1200
YAML                                     8             47             28           1163
DOS Batch                               21            202            105           1104
DTD                                      3            198             74            623
Meson                                    2             44             11            409
Qt Project                              42            147              4            363
Windows Module Definition                4             16             17            292
m4                                       4              9              0            286
yacc                                     1             46             79            262
diff                                     5             25            118            257
ERB                                      1             36             13            182
ReasonML                                 3            154           1126            181
Qt                                       2              0             12            101
Ruby                                     2             22             52             98
Windows Resource File                    3             22             22             91
XSD                                      1             10              0             89
Windows Message File                     2             14             25             77
PO File                                  5             19              7             73
Fortran 90                               1              4              2             54
Specman e                                1            138             15             48
Bourne Again Shell                       3              8              0             43
ProGuard                                 1             13              5             36
SAS                                      1             14             22             32
INI                                      6              3              0             30
NAnt script                              1              7              0             26
Sass                                     4              3              0             26
TOML                                     2              4              2             26
Tcl/Tk                                   1              3              6             24
QML                                      1              2              4             14
R                                        1              4              0             14
C Shell                                  1              1              0              7
OpenCL                                   2              1             18              6
Objective-C++                            3              0             18              3
IDL                                      1              0              0              1
---------------------------------------------------------------------------------------
SUM:                                 62486        1070850         850131        9981940
---------------------------------------------------------------------------------------

gitinspector failed to run statistical information for the repository
editorialbot commented 1 year ago

Wordcount for whitepaper.md is 5810

editorialbot commented 1 year ago

Failed to discover a Statement of need section in paper

MickaelMartinNevot commented 1 year ago

Failed to discover a Statement of need section in paper

There is one, as you can see:

Capture

MickaelMartinNevot commented 1 year ago

⚠️ An error happened when generating the pdf.

Why is this? We believe we have followed all the instructions, including the automatic PDF generation within our repository. Here is the result:

paper.pdf

MickaelMartinNevot commented 1 year ago

Submitting author: @MickaelMartinNevot (Mickaël Martin Nevot) Repository: https://github.com/FraDiavolo7/TAGED Branch with paper.md (empty if default branch): Version: v1.0.0 Editor: Pending Reviewers: Pending Managing EiC: George K. Thiruvathukal

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0"><img src="https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0/status.svg)](https://joss.theoj.org/papers/5bf0e66648a5ab42fdf80003867345a0)

Author instructions

Thanks for submitting your paper to JOSS @MickaelMartinNevot. Currently, there isn't a JOSS editor assigned to your paper.

@MickaelMartinNevot if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

We have no preferred reviewers, thanks.

arfon commented 1 year ago

It looks like @editorialbot is getting confused by whitepaper.md – @xuanxu – I think this is a bug when looking for paper.md (which also exists in this repo).

@MickaelMartinNevot the short term fix here is to delete or rename whitepaper.md.

MickaelMartinNevot commented 1 year ago

Now it should be fine (for the short tem fix at least). Could you try again please?

arfon commented 1 year ago

@editorialbot generate pdf

arfon commented 1 year ago

@MickaelMartinNevot – thanks for your submission to JOSS. I'm trying to understand what work is new/being submitted to JOSS. Could you explain a little more about the structure of this repository and help me understand which aspects of the software you'd be asking JOSS to review?

editorialbot commented 1 year ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

MickaelMartinNevot commented 1 year ago

@arfon - thank you for your interest. Please, take a look at our architecture structure description: https://github.com/FraDiavolo7/TAGED/blob/main/structure.txt

O marker indicates source code coming form outside and ! marker highlights main interests.

MickaelMartinNevot commented 1 year ago

By the way, my full lastname is Martin Nevot (Martin is not my midlename). Do you know how to fix footer callback name reference?

Thanks.

gkthiruvathukal commented 1 year ago

@MickaelMartinNevot I'm not sure I understand the problem here. Your name should b coming from your GH profile.

Separately, can you please respond to @arfon's earlier comment: "Could you explain a little more about the structure of this repository and help me understand which aspects of the software you'd be asking JOSS to review?"

MickaelMartinNevot commented 1 year ago

@MickaelMartinNevot I'm not sure I understand the problem here. Your name should b coming from your GH profile.

@gkthiruvathukal, GitHub only provide one field to fullname:

image

Maybe the actual script only keep the last "word" of this field, or something similar, so my lastname appear to be "Nevot", what is not. It's "Martin Nevot":

image

Separately, can you please respond to @arfon's earlier comment: "Could you explain a little more about the structure of this repository and help me understand which aspects of the software you'd be asking JOSS to review?"

I do:

@arfon - thank you for your interest. Please, take a look at our architecture structure description: https://github.com/FraDiavolo7/TAGED/blob/main/structure.txt

O marker indicates source code coming form outside and ! marker highlights main interests.

Have you take a look at the structure.txt file? If not, please do so (in file, all lines without O marker can be review, and particulary those with ! marker), and in any case, please can you precise me if you need something else?

Thanks.

arfon commented 1 year ago

Have you take a look at the structure.txt file? If not, please do so (in file, all lines without O marker can be review, and particulary those with ! marker), and in any case, please can you precise me if you need something else?

There are apparently millions of lines of code here, and I'm pretty sure that is not what you are asking JOSS to review. Please give a written summary here of what the novel contributions are in this submission, illustrating with examples.

Also, see this doc for how to be explicit about we handle your name: https://github.com/openjournals/inara/blob/main/docs/names.md

MickaelMartinNevot commented 1 year ago

Thanks for the detailed explanation of names, the guide is very clear.

As stated in the Structure.txt file, there are mainly four files of interest:

Details: CoSky.class.php handles an algorithm of the CoSky method, presented as a Database operator in the research papers and here we created it as a algorithm coded in PHP, removing the need for a Database. CuboideBlocNestedLoop.class.php implements the Bloc Nested Loop algorithm for SkyLine computation in a PHP environnement and adapted to a Cuboïde to create SkyCubes. Analysis.class.php is the analysis part of the TAGED Method and most of it is handled in there.

PageRunAnalysis.class.php is the page showing the form to run the Analysis, and present the inner and outer results of the TAGED Method (with functions comming from taged/application/src/algo/SKDisplay.class.php).

Note: these are the main parts of the method, but they rely on other code for lots of things. Theses building blocks are located only in taged/application/src and common/src. All this code has been coded in-house, albeit for some re-used from other project (the website structure).

arfon commented 11 months ago

@editorialbot query scope

Apologies for the very slow reply here, this submission got lost in a shuffle of papers between EiCs.

Following your directions here, I see the contributions are represented in these files:

cloc taged/application/src/algo/CoSky.class.php taged/application/src/algo/CuboideBlocNestedLoop.class.php taged/application/src/Analysis.class.php taged/application/src/pages/PageRunAnalysis.class.php 
       4 text files.
       4 unique files.                              
       0 files ignored.

github.com/AlDanial/cloc v 1.96  T=0.01 s (392.0 files/s, 180733.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
PHP                              4            292            698            854
-------------------------------------------------------------------------------
SUM:                             4            292            698            854
-------------------------------------------------------------------------------

This puts the submission on the smaller side of what we would typically publish in JOSS (in terms of a naïve line-of-code assessment of effort). My more general concern here though is that I'm struggling to see how this software could be considered something designed for maintainable extension (see https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort) – given the structure of this project I don't see how this could readily be extended by others. Apologies for the additional delay, but I'm going to ask our wider editorial team for their input here.

editorialbot commented 11 months ago

Submission flagged for editorial review.

arfon commented 10 months ago

@MickaelMartinNevot – my apologies it has taken so long to reach this decision, but the JOSS editorial team has concluded that this submission is not in scope for JOSS as it fails to meet our criteria of being 'software designed for maintainable extension'. This is because the contributions you are highlighting here seem to be part of a more substantial codebase/application and as such, would make review (and possible future extension of this work) very challenging.

These reasons combined with fact that the code you do highlight as the novel contribution here is on the smaller-side of what we'd consider publishable in JOSS leads us to the conclusion that it's out of scope.

One possible alternative to JOSS is to follow GitHub's guide on how to create a permanent archive and DOI for your software. This DOI can then be used by others to cite your work.

arfon commented 10 months ago

@editorialbot reject

editorialbot commented 10 months ago

Paper rejected.