Finalise 'Begin' folder name and structure

[colinpmillar]

Summary

We need to finalise the name and structure of the script and folder that sets up the software and data for a TAF analysis

Tasks required

• [x] Agree on a name - options: Begin or Bootstrap
• [x] Agree on folder structure

Notes

The folder will be populated with:

• data and software available on the web
• data and software not available online

In the case of the second bullet, we need to be able to identify what data and software is uploaded by the user rather than accessed via a webservice or api

[colinpmillar]

@HjalteParner and @neil-ices-dk have a preference for Bootstrap over begin. see: https://github.com/ices-taf/doc/issues/211#issuecomment-423141123

[neil-ices-dk]

and some trivia, bootstrapping is an adynaton https://en.wikipedia.org/wiki/Adynaton

[neil-ices-dk]

just found these stickers on OneNote, let the fun begin ;)

[colinpmillar]

Proposed, final folder structure is:

before bootstrap.R is run all there is only the bootstrap/initial folder

• initial: holds all uploaded, data, r packages and software after bootstrap.R folder is run there is potentially the following
• packages: holds the downloaded source code of the packages
• data: holds all downloaded datasets
• software: holds other software and code that is not an R package
• library: a local, system specific, R library (not version controlled)

  bootstrap
    |
    |___initial
        |___data
            |___uploaded_dataset_1
            |___uploaded_dataset_2
        |___packages
        |___software
    |
    |___data
        |___downloaded_dataset_1
        |___downloaded_dataset_1
        |___uploaded_dataset_1
        |___uploaded_dataset_2
    |
    |___software
        |___model_executable
    |
    |___packages
        |___downloaded_source_code_1
        |___downloaded_source_code_2
    |
    |___library _(not version controlled)_
        |___installed_package_1
        |___installed_package_2

Note the bootstrap\library folder is not stored on github

[colinpmillar]

Agreed :)