small doc fixes for CRAN release

Author: Athospd

.Rbuildignore

@@ -1,7 +1,7 @@
+^CRAN-RELEASE$
 ^appveyor\.yml$
 ^\.travis\.yml$
 ^README\.Rmd$
 ^LICENSE\.md$
 ^.*\.Rproj$
 ^\.Rproj\.user$
-^\.Rproj\.user$

CRAN-RELEASE

@@ -0,0 +1,2 @@
+This package was submitted to CRAN on 2019-02-05.
+Once it is accepted, delete this file and tag the release (commit 1059c9021a).

DESCRIPTION

@@ -1,11 +1,11 @@
 Package: shinyhttr
 Type: Package
-Title: Progress Bars For Downloads In Shiny Apps
+Title: Progress Bars for Downloads in Shiny Apps
 Version: 1.0.0
 Author: Athos Petri Damiani <[email protected]>
 Maintainer: Athos Petri Damiani <[email protected]>
-Description: This package modifies the httr::progress function to let it 
-    send output to shinyWidgets::progressBar. It is just a tweak at the 
+Description: Modifies the `httr::progress()` function to let it 
+    send output to `shinyWidgets::progressBar()`. It is just a tweak at the 
     original functions from httr to make it smooth for shiny developers.
 License: MIT + file LICENSE
 BugReports: https://github.com/curso-r/shinyhttr/issues

R/progress.R

@@ -1,15 +1,15 @@
-#' Add a progress bar compatible with shinyWidgets::progressBar.
+#' Add a progress bar compatible with `shinyWidgets::updateProgressBar()`.
 #'
-#' Add a progress bar to request just like the vanilla httr::progress but with capability to talk to shinyWidgets::progressBar by giving the session and id arguments to it.
+#' Add a progress bar to request just like the vanilla `httr::progress()` but with capability to talk to `shinyWidgets::updateProgressBar()` by giving the session and id arguments to it.
 #'
-#' @param session (from shinyWidgets::updateProgressBar doc) The 'session' object passed to function given to shinyServer.
-#' @param id (from shinyWidgets::updateProgressBar doc) An id used to update the progress bar.
-#' @param type 	(from httr::progress doc) Type of progress to display: either number of bytes uploaded or downloaded.
-#' @param con (from httr::progress doc) Connection to send output too. Usually \code{stdout()} or \code{stderr}.
-#' @param title (from shinyWidgets::updateProgressBar doc) character, optional title.
-#' @param status (from shinyWidgets::updateProgressBar doc) Color, must be a valid Bootstrap status : primary, info, success, warning, danger.
-#' @param range_value (from shinyWidgets::updateProgressBar doc) Default is to display percentage ([0, 100]), but you can specify a custom range, e.g. -50, 50.
-#' @param unit_mark (from shinyWidgets::updateProgressBar doc) Unit for value displayed on the progress bar, default to "\%".
+#' @param session (from `shinyWidgets::updateProgressBar()`` doc) The 'session' object passed to function given to shinyServer.
+#' @param id (from `shinyWidgets::updateProgressBar()` doc) An id used to update the progress bar.
+#' @param type 	(from `httr::progress()`` doc) Type of progress to display: either number of bytes uploaded or downloaded.
+#' @param con (from `httr::progress()` doc) Connection to send output too. Usually \code{stdout()} or \code{stderr}.
+#' @param title (from `shinyWidgets::updateProgressBar()` doc) character, optional title.
+#' @param status (from `shinyWidgets::updateProgressBar()` doc) Color, must be a valid Bootstrap status : primary, info, success, warning, danger.
+#' @param range_value (from `shinyWidgets::updateProgressBar()` doc) Default is to display percentage ([0, 100]), but you can specify a custom range, e.g. -50, 50.
+#' @param unit_mark (from `shinyWidgets::updateProgressBar()` doc) Unit for value displayed on the progress bar, default to "\%".
 #'
 #' @export
 #' 
@@ -92,21 +92,21 @@ progress <- function (
 
 #' progress_bar
 #'
-#' same as httr:::progress_bar but with capability to talk to shinyWidgets::progressBar.
+#' Same as `httr:::progress_bar()` but with capability to talk to `shinyWidgets::progressBar()`.
 #'
-#' @param type 	(from httr::progress doc) Type of progress to display: either number of bytes uploaded or downloaded.
-#' @param con (from httr::progress doc) Connection to send output too. Usually \code{stdout()} or \code{stderr}.
-#' @param session (from shinyWidgets::updateProgressBar doc) The 'session' object passed to function given to shinyServer.
-#' @param id (from shinyWidgets::updateProgressBar doc) An id used to update the progress bar.
-#' @param title (from shinyWidgets::updateProgressBar doc) character, optional title.
-#' @param status (from shinyWidgets::updateProgressBar doc) Color, must be a valid Bootstrap status : primary, info, success, warning, danger.
-#' @param range_value (from shinyWidgets::updateProgressBar doc) Default is to display percentage ([0, 100]), but you can specify a custom range, e.g. -50, 50.
-#' @param unit_mark (from shinyWidgets::updateProgressBar doc) Unit for value displayed on the progress bar, default to "\%".
+#' @param type 	(from `httr::progress()` doc) Type of progress to display: either number of bytes uploaded or downloaded.
+#' @param con (from `httr::progress()` doc) Connection to send output too. Usually \code{stdout()} or \code{stderr}.
+#' @param session (from `shinyWidgets::updateProgressBar()` doc) The 'session' object passed to function given to shinyServer.
+#' @param id (from `shinyWidgets::updateProgressBar()` doc) An id used to update the progress bar.
+#' @param title (from `shinyWidgets::updateProgressBar()` doc) character, optional title.
+#' @param status (from `shinyWidgets::updateProgressBar()` doc) Color, must be a valid Bootstrap status : primary, info, success, warning, danger.
+#' @param range_value (from `shinyWidgets::updateProgressBar()` doc) Default is to display percentage ([0, 100]), but you can specify a custom range, e.g. -50, 50.
+#' @param unit_mark (from `shinyWidgets::updateProgressBar()` doc) Unit for value displayed on the progress bar, default to "\%".
 #'
 #'
 #' @return a function with rules to print out the progress.
 #'
-#' @seealso \code{\link{progress}}
+#' @seealso \code{\link{progress}}, \code{\link[shinyWidgets]{progressBar}}
 #'
 progress_bar <- function (
   type,

README.Rmd

@@ -37,7 +37,13 @@ httr::GET("http://download.com/large_file.txt",
 
 ## Installation
 
-`shinyhttr` is not on CRAN yet. To install it, you may use `devtools`:
+From CRAN:
+
+```{r, eval=FALSE}
+install.packages("shinyhttr")
+```
+
+From github:
 
 ```{r, eval=FALSE}
 devtools::install_github("curso-r/shinyhttr")

README.md

@@ -30,7 +30,13 @@ httr::GET("http://download.com/large_file.txt",
 
 ## Installation
 
-`shinyhttr` is not on CRAN yet. To install it, you may use `devtools`:
+From CRAN:
+
+``` r
+install.packages("shinyhttr")
+```
+
+From github:
 
 ``` r
 devtools::install_github("curso-r/shinyhttr")