Creates the R-package structure with Best practices

[sk-sahu]

PR purpose

This creates R-package structure from scratch with usethis pkg best practices.

Adds

In addition to basic structure of R-package it adds

• Unit test with usethis::use_testthat()
• GitHub Actions with usethis::use_github_action_check_full() for CI/CD test.
• Documentation with usethis::use_pkgdown() and pkgdown::build_site()

Note

Please ignore current existing functions. Those are old. This PR is just for the structure of R-package. Functions will be rewritten with best practices.

Thanks for the suggestions @cgpu :)

[cgpu]

Thanks @sk-sahu. Are we addressing the function names and variable names convention to snake_case in this PR as well?

Here's a recap of what we have addressed thus far based on suggestions here:

• usethis::create_package was used to create the package structure (bonus: out of the box packagedown)
• Rename repo to lowercase only, no dashes
• lintr action added in this branch as well from b8909d3
• for functions and variable names it would be better to use snake_case instead of camelCase
  this is suggested by many but here's a snippet from the Advanced R book.)

Variable and function names should be lowercase. Use an underscore () to separate words within a name. Generally, variable names should be nouns and function names should be verbs.

[sk-sahu]

Thank you for the review @cgpu

As I mentioned in the Note section of this PR description. We will adhere the snake_case for function and variable naming. Currently having function are old (written by someone else earlier) and they will be refactored. Working on that in a different branch, it will be a different PR. This PR is mostly for the skeleton of the R-package.

Hope this clears the current concern.

[sk-sahu]

Hi @cgpu

The new commits implements two API end points, although they are in experimental phase (tested in an abstract manner).

And this complies with

• For functions and variable names it would be better to use snake_case instead of camelCase

Let me know if any other improvements you can suggest with this PR

[cgpu]

This is the only function not replaced, I assume this is intended as it is depricated? Can you verify @sk-sahu. If this needs to be refactored feel free to open an issue to keep track of what's being re-implemented.

[sk-sahu]

I tested this. Working at the moment. But I'll cross check again.

Also, I'l create an issue to track all up-to-date end points.

[cgpu]

Looks good to me, can you check the comments and then we should be good to merge this first iteration.

[cgpu]

Awesome job @sk-sahu !