Skip to content

Commit 7172950

Browse files
prep for CRAN
1 parent 163f69f commit 7172950

13 files changed

+212
-181
lines changed

Diff for: .Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
docs
88
^tests$
99
^\.github$
10+
^cran-comments\.md$

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2018
3+
Copyright (c) 2021
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: R/dependencies.R

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
#' @export
1111
#'
1212
#' @examples
13+
#' if(interactive()){
14+
#'
1315
#' library(vueR)
1416
#' library(htmltools)
1517
#'
@@ -29,6 +31,7 @@
2931
#' ),
3032
#' html_dependency_vue()
3133
#' )
34+
#' }
3235
html_dependency_vue <- function(offline=TRUE, minified=TRUE){
3336
hd <- htmltools::htmlDependency(
3437
name = "vue",

Diff for: README.Rmd

+10-4
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ knitr::opts_chunk$set(
1919

2020
[Vue.js](https://vuejs.org) is a quiet, very popular JavaScript framework with an impressive set of features, a solid community, and MIT license. Don't tell anybody, but I think I might even like it better than React. With all this, Vue deserves its own set of helpers for `R`, just like [`d3r`](https://github.com/timelyportfolio/d3r) and [`reactR`](https://github.com/react-r/reactR).
2121

22-
`vueR` provides these helpers with its dependency function `html_dependency_vue` and ?htmlwidget?.
22+
`vueR` provides these helpers with its dependency function `html_dependency_vue()` and `htmlwidget` helper `vue()`.
2323

2424

2525
### Installation
2626

27-
`vueR` aims to achieve CRAN status, but for now, it only exists on Github.
27+
```
28+
install.packages("vueR")
29+
```
30+
31+
or for the latest if different from CRAN
2832

2933
```
30-
devtools::install_github("vue-r/vueR")
34+
remotes::install_github("vue-r/vueR")
3135
```
3236

3337
### Example
@@ -78,10 +82,12 @@ browsable(
7882
)
7983
```
8084

85+
Also, please check out additional [examples](https://github.com/vue-r/vueR/tree/master/inst/examples) and [experiments](https://github.com/vue-r/vueR/tree/master/inst/experiments).
86+
8187
### Build/Update
8288

8389
`vueR` is now part of a Github organization, and hopefully will be backed with interest by more than one (me) developer. For most `vueR` users, this section will not apply, but I would like to document the build/update step for new versions of `Vue`. In [`getvue.R`](https://github.com/vue-r/vueR/blob/master/build/getvue.R), I created some functions for rapid download and deployment of new `Vue` versions. Running all of the code in `getvue.R` should update local minified and development versions of Vue and also update the version references in `vueR`.
8490

8591
### Code of Conduct
8692

87-
I would love for you to participate and help with `vueR`, but please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
93+
I would love for you to participate and help with `vueR`, but please note that this project is released with a [Contributor Code of Conduct](https://github.com/vue-r/vueR/blob/master/CONDUCT.md). By participating in this project you agree to abide by its terms.

Diff for: README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ just like [`d3r`](https://github.com/timelyportfolio/d3r) and
1515
[`reactR`](https://github.com/react-r/reactR).
1616

1717
`vueR` provides these helpers with its dependency function
18-
`html_dependency_vue` and ?htmlwidget?.
18+
`html_dependency_vue()` and `htmlwidget` helper `vue()`.
1919

2020
### Installation
2121

22-
`vueR` aims to achieve CRAN status, but for now, it only exists on
23-
Github.
22+
install.packages("vueR")
2423

25-
devtools::install_github("vue-r/vueR")
24+
or for the latest if different from CRAN
25+
26+
remotes::install_github("vue-r/vueR")
2627

2728
### Example
2829

@@ -74,6 +75,10 @@ browsable(
7475
)
7576
```
7677

78+
Also, please check out additional
79+
[examples](https://github.com/vue-r/vueR/tree/master/inst/examples) and
80+
[experiments](https://github.com/vue-r/vueR/tree/master/inst/experiments).
81+
7782
### Build/Update
7883

7984
`vueR` is now part of a Github organization, and hopefully will be
@@ -90,5 +95,5 @@ references in `vueR`.
9095

9196
I would love for you to participate and help with `vueR`, but please
9297
note that this project is released with a [Contributor Code of
93-
Conduct](CONDUCT.md). By participating in this project you agree to
94-
abide by its terms.
98+
Conduct](https://github.com/vue-r/vueR/blob/master/CONDUCT.md). By
99+
participating in this project you agree to abide by its terms.

Diff for: cran-comments.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Test environments
2+
* local R installation, R 4.1.1
3+
* ubuntu 16.04 (on github-actions), R 4.1.1
4+
* win-builder (devel, release)
5+
6+
## R CMD check results
7+
8+
0 errors | 0 warnings | 1 note
9+
10+
* This is a new release.

Diff for: docs/index.html

+8-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: docs/pkgdown.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ pkgdown: 1.6.1
33
pkgdown_sha: ~
44
articles:
55
intro_to_vueR: intro_to_vueR.html
6-
last_built: 2021-11-25T16:10Z
6+
last_built: 2021-11-25T16:51Z
77

Diff for: docs/reference/html_dependency_vue.html

+5-10
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)