Pre Publishing Code Review

[colinpmillar]

Main comments

Good to go with a few comments (see suggested follow up below)

• The code follows a heirarchihcal structure following the standard Golum architecture for shiny apps.
• Each region or sub-region has its logical code and user interface code in individual modules / ui scripts, and are named appropriatley.
• This means code is findable and modifiable by someone with limited prior knowledge of the codebase, and is therefore maintainable.
• Variables are named sensibly.
• Common features accross tabs and pages are abstracted so that modifying, e.g. common text in pages, requires only changes to a small number of files.
• Creation of data is documented in data-raw

Detailed comments (some pedantry)

• Ideally dont use T for TRUE as T is not reserved and can accidentally be written over.

Suggested follow up tasks

• CITATION file with ICES doi and standard ICES app citation should be included
• Add code authors as aut or ctb to DESCRIPTION file
• Check that all scripts are included in \data-raw, at time of review \data-raw\wp3\*.R were not on github
• Potentially publish \data folder to github so that the app package is installable and runable
• If adding \data folder, check that MIT license is appropriate for all data being published

see: https://journal.r-project.org/articles/RJ-2012-009/ for information on documenting code contributions to R packages

Comments for future apps

• consider using the TAF \boot\DATA.bib technology and data.R etc. to generate and document the processed data for the app

[neil-ices-dk]

Agreeing with @colinpmillar remarks and follow-up tasks. Additionally, some of these elements will be needed (mandatory) for a landing page on the ICES website under the https://www.ices.dk/data/assessment-tools/Pages/default.aspx

• data license should specifically be CC BY 4.0 (even if the code is MIT license) but you could consider for simplification putting both under CC BY
• meta data record should be created on geonetwork for this resource
• as Colin remarked, a clear citation file is needed

[neil-ices-dk]

@Neilmagi

App

1. found the meta data record 👍but it should point to a specific license (not just the data policy)
2. same applies in the 'resources' tab, it should point to CC BY https://creativecommons.org/licenses/by/4.0
3. best practice to use a generic email or an office form to capture feedback questions rather than a named email, please change

[Neilmagi]

Thanks for the reviews @neil-ices-dk @colinpmillar. I will address your comments and issues raised.

[Neilmagi]

Addressed Neil H issues 1,2 & 3 in app. Following up with Periklis re. metadata record