Skip to content

Commit e3c5600

Browse files
clean up docs and prep for CRAN
1 parent 20cfdc4 commit e3c5600

File tree

9 files changed

+37
-23
lines changed

9 files changed

+37
-23
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
^\.Rproj\.user$
33
^\build
44
^CONDUCT\.md$
5+
^cran-comments\.md$

DESCRIPTION

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Package: reactR
22
Type: Package
3-
Title: React Dependencies for R
3+
Title: React Helpers for R
44
Version: 0.1.0
5+
Date: 2016-11-04
56
Authors@R: c(
67
person(
78
"Facebook", "Inc"
@@ -16,8 +17,12 @@ Authors@R: c(
1617
)
1718
)
1819
Maintainer: Kent Russell <[email protected]>
19-
Description: Make it easy .
20-
License: MIT + file LICENSE
20+
Description: Make it easy to use 'react' in R with helper
21+
dependency functions, embedded 'Babel' transpiler,
22+
and examples.
23+
URL: https://github.com/timelyportfolio/reactR
24+
BugReports: https://github.com/timelyportfolio/reactR/issues
25+
License: BSD_3_clause + file LICENSE
2126
LazyData: TRUE
2227
Imports:
2328
htmltools

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
YEAR: 2016
2-
COPYRIGHT HOLDER: Your name goes here
2+
COPYRIGHT HOLDER: Kenton Russell

R/babel.R

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@
99
#' @export
1010
#'
1111
#' @examples
12+
#' \dontrun{
1213
#' library(reactR)
1314
#' babel_transform('<div>react div</div>')
15+
#' }
1416
babel_transform <- function(code=""){
15-
stopifnot(require(V8), is.character(code))
17+
stopifnot(requireNamespace("V8"), is.character(code))
1618

17-
ctx <- v8()
19+
ctx <- V8::v8()
1820
ctx$source('https://cdnjs.cloudflare.com/ajax/libs/babel-standalone/6.10.3/babel.min.js')
1921
ctx$assign('code', code)
2022
ctx$get('Babel.transform(code,{ presets: ["es2015","react"] }).code')

R/dependencies.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#'
33
#' @param offline \code{logical} to use local file dependencies. If \code{FALSE},
44
#' then the dependencies use the Facebook cdn as its \code{src}.
5+
#' To use with \code{JSX} see \code{\link{babel_transform}}.
56
#'
67
#' @return \code{\link[htmltools]{htmlDependency}}
78
#' @importFrom htmltools htmlDependency
@@ -11,7 +12,7 @@
1112
#' library(reactR)
1213
#' library(htmltools)
1314
#'
14-
#' browsable(attachDependencies(
15+
#' attachDependencies(
1516
#' tags$script(
1617
#' "
1718
#' ReactDOM.render(
@@ -25,7 +26,7 @@
2526
#' "
2627
#' ),
2728
#' html_dependency_react()
28-
#' ))
29+
#' )
2930
html_dependency_react <- function(offline=TRUE){
3031
hd <- htmltools::htmlDependency(
3132
name = "react",

cran-comments.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Test environments
2+
* local Windows 10 install, R 3.3.1
3+
* ubuntu 12.04 (on travis-ci), R 3.3.1
4+
* rhub check_for_cran
5+
6+
## R CMD check results
7+
8+
0 errors | 0 warnings | 1 note
9+
10+
* This is a new release.
11+
12+
## Reverse dependencies
13+
14+
This is a new release, so there are no reverse dependencies.

man/babel_transform.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/hello.Rd

Lines changed: 0 additions & 12 deletions
This file was deleted.

man/html_dependency_react.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)