Modified README.Rmd and tutorial to refer to CIP-RIU

jmh579 · Aug 11, 2017 · 0f604ab · 0f604ab
1 parent 0a63efd
commit 0f604ab
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 18 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -26,17 +26,17 @@ It can be installed using:
 
 ```{r, eval=FALSE}
 install.packages("devtools")
-devtools::install_github("c5sire/brapi")
+devtools::install_github("CIP-RIU/brapi")
 ```
 
 
 ## How to use the package
 
-See [tutorial](https://github.com/c5sire/brapi/blob/master/inst/doc/tutorial.Rmd).
+See [tutorial](https://github.com/CIP-RIU/brapi/blob/master/inst/doc/tutorial.Rmd).
 
 ## Documentation of JSON response/requests
 
-Follow the links in the table below or see the inst/apidocs directory for examples: [apidocs](https://github.com/c5sire/brapi/blob/master/inst/apidocs/README.md)
+Follow the links in the table below or see the inst/apidocs directory for examples: [apidocs](https://github.com/CIP-RIU/brapi/blob/master/inst/apidocs/README.md)
 
 ## Implementation status
 
@@ -60,7 +60,7 @@ Out of `r nrow(calls_data)` BrAPI calls currently **`r nrow(res)` (`r pct`%)** a
 ```{r, echo=FALSE}
 
 
-res[, 3] <- paste0("[", res[, 3], "](https://github.com/c5sire/brapi/blob/master/inst/apidocs/", res[, 3], ".md)") 
+res[, 3] <- paste0("[", res[, 3], "](https://github.com/CIP-RIU/brapi/blob/master/inst/apidocs/", res[, 3], ".md)") 
 
 res[, 2] <- paste0("[", res[, 2], "](https://github.com/plantbreeding/API/blob/master/Specification/", res[, 1], "/", 
                    res[, 2], ".md)") 
@@ -70,8 +70,6 @@ knitr::kable(res, row.names = FALSE)
 
 ```
 
-
-
 ```{r eval=FALSE, echo=FALSE}
 rp =covr::package_coverage()
 
@@ -84,7 +82,3 @@ mdfiles <- list.files(".", "*.Rmd")
 sapply(mdfiles, knitr::knit)
 setwd(owd)
 ```
-
-
-
-
diff --git a/inst/doc/tutorial.Rmd b/inst/doc/tutorial.Rmd
@@ -36,7 +36,7 @@ R -e "brapiTS::mock_server()"
 The server must be started in a R session separate from the one use for the BrAPI calls.
 The server uses by default the port 2021. This can be changed by using the port parameter: brapi::mock_server(80).
 
-The mock server package 'brapiTS' is available [here](https://github.com/c5sire/brapiTS).
+The mock server package 'brapiTS' is available [here](https://github.com/CIP-RIU/brapiTS).
 
 # Starting the connection
 

diff --git a/inst/doc/tutorial.html b/inst/doc/tutorial.html
@@ -4,15 +4,15 @@
 
 <head>
 
-<meta charset="utf-8">
+<meta charset="utf-8" />
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="pandoc" />
 
 <meta name="viewport" content="width=device-width, initial-scale=1">
 
 <meta name="author" content="Reinhard Simon" />
 
-<meta name="date" content="2017-03-06" />
+<meta name="date" content="2017-08-11" />
 
 <title>Basic Tutorial</title>
 
@@ -70,7 +70,7 @@
 
 <h1 class="title toc-ignore">Basic Tutorial</h1>
 <h4 class="author"><em>Reinhard Simon</em></h4>
-<h4 class="date"><em>2017-03-06</em></h4>
+<h4 class="date"><em>2017-08-11</em></h4>
 
 
 
@@ -85,12 +85,12 @@ <h4 class="date"><em>2017-03-06</em></h4>
 <h1>NEW</h1>
 <div id="sandbox-testing-server" class="section level2">
 <h2>Sandbox testing server</h2>
-<p>To eaes local testing the package has now a companion package with a localized simple testing server implementing the BrAPI v1 protocol. To start this server use in an R session:</p>
+<p>To ease local testing the package has now a companion package with a localized simple testing server implementing the BrAPI v1 protocol. To start this server use in an R session:</p>
 <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">brapiTS::<span class="kw">mock_server</span>()</code></pre></div>
 <p>or on the command line in an MS-DOS box</p>
 <div class="sourceCode"><pre class="sourceCode r"><code class="sourceCode r">R -e <span class="st">&quot;brapiTS::mock_server()&quot;</span></code></pre></div>
 <p>The server must be started in a R session separate from the one use for the BrAPI calls. The server uses by default the port 2021. This can be changed by using the port parameter: brapi::mock_server(80).</p>
-<p>Soon, the mock_server function will be moved to its own package ‘brapiTS’.</p>
+<p>The mock server package ‘brapiTS’ is available <a href="https://github.com/CIP-RIU/brapiTS">here</a>.</p>
 </div>
 </div>
 <div id="starting-the-connection" class="section level1">
@@ -115,7 +115,7 @@ <h1>NEW: Testing the calls</h1>
 <div id="new-return-tables" class="section level1">
 <h1>NEW: return tables</h1>
 <ul>
-<li><p>all R functions using the brapi have a new parameter: rclass which can have up to five different values: json, list, data.frame, tibble, vector. The default value is tibble for most functions - that is it will alwways return a table. Vector is default for very small return objects like in the case of ‘crops’.</p></li>
+<li><p>all R functions using the brapi have a new parameter: rclass which can have up to five different values: json, list, data.frame, tibble, vector. The default value is tibble for most functions - that is it will always return a table. Vector is default for very small return objects like in the case of ‘crops’.</p></li>
 <li><p>also: all R functions are checked against the list of calls provided by the server. That is: if a certain server does not implement all calls the corresponding R functions will not ‘insist’ calling it.</p></li>
 </ul>
 </div>
@@ -127,7 +127,7 @@ <h1>NEW: return tables</h1>
   (function () {
     var script = document.createElement("script");
     script.type = "text/javascript";
-    script.src  = "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
+    script.src  = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
     document.getElementsByTagName("head")[0].appendChild(script);
   })();
 </script>