Skip to content
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.

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

New R package for REST API #107

Closed
Ramshreyas opened this issue Jun 30, 2021 · 7 comments
Closed

New R package for REST API #107

Ramshreyas opened this issue Jun 30, 2021 · 7 comments

Comments

@Ramshreyas
Copy link
Contributor

Hi Guys,

I've put together an R package for the REST API - https://github.com/Ramshreyas/rcoinapi

The aim is to mimic Quantmod response objects (basically the OHLCV data), so that existing functionality can be brought to bear with minimum effort.

Feedback most welcome!

@Svisstack
Copy link
Contributor

@Ramshreyas Great job!

Can you just make PR to this repo as we will have it in ./data-api/r-rest-2 directory and other people can participate in developing that alongside?

@Ramshreyas
Copy link
Contributor Author

Ramshreyas commented Jul 10, 2021

@Svisstack sure, I'll do that but to be honest it won't be very useful to R coders.

The way R works developers working with github packages (as opposed to the official CRAN repos) do this:

install_github("Ramshreyas/rcoinapi")

With just the "name of the user/name of repo" as the argument.

You will be better off forking my repo, so that they can do:

install_github("coinapi/r")

or whatever name you prefer. Then PRs can go directly to that repo and usage, testing etc will work out of the box.

Plus, the way the auto-generated documentation (which I've also created) namespace etc works, it's better if it is at the root of the repo and therefore easy for others to work with.

If the code is buried in your SDKs repo, there are a couple of steps before R programmers can get started working with the package immediately, and they will have to do it each time they want to make a change.

Let me know how you would like to proceed!

Also, I'm putting together a tutorial which shows the API working within a typical R backtesting workflow, which I'll post here once it's ready.

@Ramshreyas
Copy link
Contributor Author

@Svisstack : as promised, here is a complete tutorial using RCoinAPI (or whatever you want to call it in the future) to get Crypto data and perform a backtest using Quantstrat, the industry standard for backtesting in R:

https://philosophyofquant.com/post/2021-07-05-rcoinapi/

Please let me know if you prefer a PR to your existing repo (which I'd advise against) or would you like to just fork my repo, and we can proceed and close accordingly.

Cheers!

@Ramshreyas
Copy link
Contributor Author

@Svisstack I'm assuming you prefer the code under ./data-api/r-rest-2 as opposed to a new repo - have made the PR accordingly.

@Svisstack
Copy link
Contributor

Hi, @Ramshreyas Thanks for making that happen in the subdirectory fashion as it reflects our current SDK structure where there multiple languages in the separate subdirectories instead of separate repositories.

Can you also advise if that import line is correct after the merge?

0b8aa47#diff-727b26c4933a46e039d64e662a92c107252bbd9b4579dfc2fe97f6824af8cf19R28

Thanks for the contribution!

@Ramshreyas
Copy link
Contributor Author

Ramshreyas commented Sep 15, 2021 via email

@Svisstack
Copy link
Contributor

@Ramshreyas Thanks for confirming. Have a nice week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants