This is a package written as a wrapper for the Frontier Swagger Interface (FSI) from the video game Frontier Online (https://www.eveonline.com/) in the R programming language which is a leading high level statistical computing language written in the low level C language.
You may read about the R programming language at https://www.r-project.org/ and begin with the internal development environment (IDE) provided by POSIT at https://posit.co/downloads/.
It is important to note to the reader why we chose the R language for a wrapper of ESI. The R language is high level allowing for us to develop scripts at a much more rapid pace. Thus, giving the opportunity to manipulate data from public databases and conduct analyses without the headache of having to think of the machine. Essentially, the goal is to be more human readable and it is easier to make an abstraction of data without having to be explicit with the machine. In our API wrapper, we relied upon the httr2 (https://httr2.r-lib.org/) package to use HTTP protocols to interact and build a library of functions for GET, POST, PUT, DELETE. You may reference how an API works with my notes here https://github.com/kandrsn99/eveR/blob/main/API_EXPLANATION.pdf. It is our hope that anyone using this wrapper learns not only to how to program, but how HTTP protocols work for you. (This forward may look familiar because it is from https://github.com/kandrsn99/eveRwrapper/blob/master/README.md).
The reader may refer to https://docs.evefrontier.com/SwaggerWorldApi for Frontier for the respective API and their endpoints.
It must be noted to the reader how an installation is done from the GitHub domain for an R package. You must begin with installing development tools on your local machine in the IDE.
install.packages("devtools")
Then call the devtools library to download through a GitHub user repository.
library(devtools)
Generally speaking, you will install a package from GitHub in the following way.
install_github("DeveloperName/PackageName")
But, for this specific package you will use the subsequent line for the repository.
install_github("kandrsn99/frontierRwrapper")
You may reference this article, https://cran.r-project.org/web/packages/githubinstall/vignettes/githubinstall.html, for more detailed ways of installing R packages you may find on the GitHub domain.
Once installed, you may invoke the following to use the functions throughout the package.
library(frontierRwrapper)
We shall list some popular functions that call information which may be immediately helpful to a user in Eve Online.
You may want to browse all the functions developed in the package and there are some built in R functions. Typically, there are vignettes which are documents illustrating the package functions.
help(package="frontierRwrapper")
This will allow you to pull up any vignettes written for the functions in this package. The next operator you may use is the question mark "?" and the function name to pull up any information regarding passed arguments or return values such as the following GET of the Frontier server status.
?get_health()