Docs: Run script

[avisionh]

Summary

This PR adds documentation on how to run the code so other people can apply it.

Changes

The changes made in this PR are:

1. README.md updated to describe what scripts to run.
2. Update these scripts so they work.
   ...

Check

• The instructions are clear.

...

Note

This "fixes #19"

[mvolfik]

It would be nice to list required R version – in Ubuntu LTS repositories is only 3.something, so I installed it, and only after trying to run _build.sh I found out that it actually requires v4.

However, after that, I'm still unable to run it. As somebody with zero experience with R, I have no idea what does "access and run a script" mean, and naive R src/galeshapley.R didn't work - it says ARGUMENT 'src/galeshapley.R' __ignored__

[avisionh]

It would be nice to list required R version – in Ubuntu LTS repositories is only 3.something, so I installed it, and only after trying to run _build.sh I found out that it actually requires v4.

However, after that, I'm still unable to run it. As somebody with zero experience with R, I have no idea what does "access and run a script" mean, and naive R src/galeshapley.R didn't work - it says ARGUMENT 'src/galeshapley.R' __ignored__

Thanks for the feedback @mvolfik. The required R version will be in the renv.lock file here. You can think of it as the Python equivalent of a requirements.txt file. I take your point that this is still not friendly for people with no R experience. I plan to formalise this work into possibly a package but that will require more time. Doing this would then make it easier run from the command line.

In the meantime, when I say access and run ..., I mean to do the following:

1. Open the file in RStudio, an IDE for R.
2. Highlight and execute each line in the scripts, individually. You can execute by pressing the keyboard short CTRL+ENTER or CMD+ENTER (on mac).

Does that help?