Skip to content

Docs: Run script #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Docs: Run script #22

wants to merge 4 commits into from

Conversation

avisionh
Copy link
Owner

@avisionh avisionh commented Jan 2, 2021 •
edited
Loading

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"

@avisionh
fix: Pass in list of double and character
71d13ae 
This is so function works.

Also, remove legacy code in main.R of iterative preference function because it will not work with the data shape.

Update link to functions script to use new folder name.
@avisionh
chore: Rename and move files
66c9f2d 
This is so they are organised more appropriately.
@avisionh
docs: Update README on how to run method
a5e8899 
This is so others can easily know where to go to apply this method.
@avisionh
docs: Add badges
61a94d0 
This is to make README more pretty.
@mvolfik
Copy link

mvolfik commented Jan 2, 2021

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
Copy link
Owner Author

avisionh commented Jan 9, 2021 •
edited
Loading

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Missing usage docs

2 participants

@avisionh @mvolfik