Skip to content

Commit

Permalink
README paragraph justification
Browse files Browse the repository at this point in the history
  • Loading branch information
jaor committed May 8, 2012
1 parent f1de544 commit 9651bfe
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
@@ -1,5 +1,5 @@
This repo contains the source code used to generate the BigML api bindings This repo contains the source code used to generate the BigML api
for R. bindings for R.


Please, report problems and bugs to our Please, report problems and bugs to our
[BigML.io issue tracker](https://github.com/bigmlcom/io/issues) [BigML.io issue tracker](https://github.com/bigmlcom/io/issues)
Expand All @@ -11,20 +11,28 @@ in our [Campfire chatroom](https://bigmlinc.campfirenow.com/f20a0)
# Build # # Build #


There is a small bundle.R script that will build a CRAN-ready bundle. There is a small bundle.R script that will build a CRAN-ready bundle.
[Roxygen2](http://cran.r-project.org/web/packages/roxygen2/index.html) is [Roxygen2](http://cran.r-project.org/web/packages/roxygen2/index.html)
necessary for building the package documentation. Simply run the script in is necessary for building the package documentation. Simply run the
R while in the project directory. script in R while in the project directory.


# Tests # # Tests #


There is a small unit test script called run_tests.R. There is a small unit test script called run_tests.R.


These tests compare the class structure of bigml responses to the expected class structure (in JSON form). It will also check for specific known responses (e.g., A particular response for a prediction request on a model trained from the iris dataset). Simply evaluate the code in run_tests.R in the project root in order to run the tests. These tests compare the class structure of bigml responses to the
expected class structure (in JSON form). It will also check for
specific known responses (e.g., A particular response for a prediction
request on a model trained from the iris dataset). Simply evaluate the
code in run_tests.R in the project root in order to run the tests.


It requires the [testthat](http://cran.r-project.org/web/packages/testthat/index.html) library by Hadley Wickham. Simply run the script in R while in the project directory It requires the
[testthat](http://cran.r-project.org/web/packages/testthat/index.html)
library by Hadley Wickham. Simply run the script in R while in the
project directory


It is necessary to run setCredentials() beforehand, or to set BIGML_USERNAME It is necessary to run setCredentials() beforehand, or to set
and BIGML_API_KEY appropriately in your .Renviron file. `BIGML_USERNAME` and `BIGML_API_KEY` appropriately in your .Renviron

file.
There are some small utilities (misc.R) that make it easier to manipulate the complex datastructures returned by R and the bigml API.


There are some small utilities (misc.R) that make it easier to
manipulate the complex datastructures returned by R and the bigml API.

0 comments on commit 9651bfe

Please sign in to comment.