Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README paragraph justification

  • Loading branch information...
commit 9651bfe34412419667cdeaf939b1d1a424ae203a 1 parent f1de544
@jaor jaor authored
Showing with 19 additions and 11 deletions.
  1. +19 −11 README.md
View
30 README.md
@@ -1,5 +1,5 @@
-This repo contains the source code used to generate the BigML api bindings
-for R.
+This repo contains the source code used to generate the BigML api
+bindings for R.
Please, report problems and bugs to our
[BigML.io issue tracker](https://github.com/bigmlcom/io/issues)
@@ -11,20 +11,28 @@ in our [Campfire chatroom](https://bigmlinc.campfirenow.com/f20a0)
# Build #
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
-necessary for building the package documentation. Simply run the script in
-R while in the project directory.
+[Roxygen2](http://cran.r-project.org/web/packages/roxygen2/index.html)
+is necessary for building the package documentation. Simply run the
+script in R while in the project directory.
# Tests #
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
-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.
+It is necessary to run setCredentials() beforehand, or to set
+`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.
Please sign in to comment.
Something went wrong with that request. Please try again.