search

Epiconcept-Paris / STRAP-epiuf

Utility function package for STRAP
0 stars 0 forks source link

Assess addition of archiving support functions copyTo and ZipGitHubRepo to epiuf #117

Open epi-jhd opened 7 months ago

epi-jhd commented 7 months ago

These are two function which can be used to 1) copyTo: retrieve any files external to a github repo (eg those which are referenced by the scripts and thus essential to the functioning of the repo) and save them inside the repo, then comit and send to github 2) ZipGitHubRepo: make an extraction of the repo into a zipped folder to be archived.

copyTo can be used for everyday copying of a list of files into a single location, without using github.

I have tried to keep them generic, but they may still be too project specific for inclusion into the epiuf package. What do you think? Would these be useful for any other project you work on or know of?

epi-gde commented 4 months ago

copyTo could be something like gitTo instead ? zipGithubRepo could be something like getGitRepo or gitFrom ? some utilsfile function could be used to simplify ;)

epi-jhd commented 3 months ago

Re function names: copyTo: the aim was that it could be used to simply find and copy a file without also doing a comit and pull push to github, so I kept the name github neutral. zipGithubRepo: the main purpose of the function is to save a zipped version of the github repo for archiving, so I wanted it in the name so this is clear. To have getGitRepo we could put zipping as an option not a default?

epi-jhd commented 3 months ago

Looking at the comments for copyTo and zipGithubRepo: these are functions designed for a very specific purpose and situation. (I tried to make them as general as possible, but did not manage this very well). We therefore need to either: a) adapt the functions to make them more general while still meeting our needs (in reality the needs VEBIS lot 1 SARI VE data management, no other project uses it or has the same needs) b) Leave them as is but include a very thorough explanation in the documentation - it might be useful to someone somewhere at some point. c) Don't include them in epiuf - the SARI-VEBIS-OLD has them in the function folder so does not require them in epiuf.