Skip to content

Commit

Permalink
reactlog v1.1.0 (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
schloerke committed Sep 14, 2020
1 parent 8c9a0aa commit 31c519d
Show file tree
Hide file tree
Showing 15 changed files with 140 additions and 205 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@
^\.github$
^logo
^pkgdown$
^revdep$
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Please briefly describe your problem and what output you expect. If you have a question, please try using the [RStudio Community website](https://community.rstudio.com/c/shiny) first.
Please briefly describe your problem and what output you expect. If you have a question, please try using the [RStudio Community website](https://community.rstudio.com/c/shiny/8) first.

Please include a minimal reprex. The goal of a reprex is to make it as easy as possible for me to recreate your problem so that I can fix it. If you've never heard of a reprex before, start by reading <https://github.com/jennybc/reprex#what-is-a-reprex>, and follow the advice further down the page. Do NOT include session info unless it's explicitly asked for, or you've used `reprex::reprex(..., si = TRUE)` to hide it away.

Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: reactlog
Title: Reactivity Visualizer for 'shiny'
Version: 1.0.0.9000
Version: 1.1.0
Authors@R: c(
person(
"Barret", "Schloerke", email = "barret@rstudio.com", role = c("aut", "cre"),
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
reactlog 1.0.0.9000
reactlog 1.1.0
==========================

- Added a shiny module to inline the current `reactlog`. See `?reactlog_module_ui` for an example (#66)
Expand Down
2 changes: 1 addition & 1 deletion R/setReactLog.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ reactlog_enable <- function() {
#' @export
#' @rdname setReactLog
reactlog_disable <- function(warn = TRUE) {
if (!isTRUE(warn) && !isFALSE(warn)) {
if (!isTRUE(warn) && !identical(warn, FALSE)) {
stop("'warn' must be either 'TRUE' or 'FALSE'")
}

Expand Down
2 changes: 1 addition & 1 deletion R/shinyModule.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' @param id \pkg{shiny} module id to use
#' @param ... parameters passed to [shiny::actionButton()]
#' @param width,height HTML attributes to be applied to the reactlog iframe
#' @param include_refresh should the ifram refresh button be included?
#' @param include_refresh should the iframe refresh button be included?
#' @seealso [shiny::moduleServer()]
#' @rdname reactlog_module
#' @export
Expand Down
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# reactlog <a href='https://rstudio.github.io/reactlog'><img src='man/figures/logo.svg' align="right" height="139" /></a>
# reactlog <a href='https://rstudio.github.io/reactlog/'><img src='man/figures/logo.svg' align="right" height="139" /></a>

<!-- badges: start -->
[![R build status](https://github.com/rstudio/reactlog/workflows/R-CMD-check/badge.svg)](https://github.com/rstudio/reactlog/actions)
Expand All @@ -14,7 +14,7 @@

<img src="http://rstudio.github.io/reactlog/readme-images/pythagoras.gif" style="border: 1px solid black; box-shadow: 5px 5px 5px #eee;" width="100%">

[Shiny](http://shiny.rstudio.com/) is an R package from RStudio that makes it incredibly easy to build interactive web applications with R. Behind the scenes, Shiny builds a reactive graph that can quickly become intertwined and difficult to debug. **reactlog** provides a visual insight into that _black box_ of Shiny reactivity.
[Shiny](https://shiny.rstudio.com/) is an R package from RStudio that makes it incredibly easy to build interactive web applications with R. Behind the scenes, Shiny builds a reactive graph that can quickly become intertwined and difficult to debug. **reactlog** provides a visual insight into that _black box_ of Shiny reactivity.

After logging the reactive interactions of a Shiny application, **reactlog** constructs a directed dependency graph of the Shiny's reactive state at any time point in the record. The **reactlog** dependency graph provides users with the ability to visually see if reactive elements are:
* Not utilized (never retrieved)
Expand All @@ -23,7 +23,7 @@ After logging the reactive interactions of a Shiny application, **reactlog** con
* Invalidating all expected dependencies
* Freezing (and thawing), preventing triggering of future reactivity

<!-- For an introduction and examples, visit the [Shiny Dev Center](http://shiny.rstudio.com/). -->
<!-- For an introduction and examples, visit the [Shiny Dev Center](https://shiny.rstudio.com/). -->


## Major Features
Expand Down Expand Up @@ -88,24 +88,24 @@ For more examples and explanation, see the [**reactlog** vignette](https://rstud

## Community Support

The best place to get help with Shiny and **reactlog** is [RStudio Community](https://community.rstudio.com/c/shiny).
The best place to get help with Shiny and **reactlog** is [RStudio Community](https://community.rstudio.com/c/shiny/8).
If you're having difficulties with **reactlog**, feel free to [ask questions here](https://community.rstudio.com/new-topic?title=&category_id=8&tags=reactlog&body=%0A%0A%0A%20%20--------%0A%20%20%0A%20%20%3Csup%3EReferred%20here%20by%20%60reactlog%60%27s%20README%3C/sup%3E%0A&u=barret).
For bug reports, please use the **reactlog** [issue tracker](https://github.com/rstudio/reactlog/issues).


## Development

[![node version: 11.x](https://img.shields.io/badge/node-11.x-brightgreen.svg)](https://nodejs.org/en/)
[![yarn version: 1.13.0](https://img.shields.io/badge/yarn-1.13.0-257bac.svg)](https://yarnpkg.com/en/)
[![node version: 12.x](https://img.shields.io/badge/node-12.x-brightgreen.svg)](https://nodejs.org/en/)
[![yarn version: 1.x](https://img.shields.io/badge/yarn-1.x-257bac.svg)](https://classic.yarnpkg.com/lang/en/)
[![JavaScript type: flow](https://img.shields.io/npm/types/flow-typed.svg)](https://github.com/flow-typed/flow-typed)
[![cytoscape version: 1.13.0](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/cytoscape.svg)](http://js.cytoscape.org/)
[![cytoscape](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/cytoscape.svg)](https://js.cytoscape.org/)
[![@babel/preset-env](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/dev/@babel/preset-env.svg)](https://babeljs.io/)
[![webpack](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/dev/webpack.svg)](https://webpack.js.org/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![linter: eslint](https://img.shields.io/badge/linter-eslint-3524ca.svg)](https://eslint.org/)


Please make sure you have [GitHub Large File Storage](https://git-lfs.github.com/), [Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/en/docs/install) installed.
Please make sure you have [GitHub Large File Storage](https://git-lfs.github.com/), [Node.js](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/en/docs/install) installed.

Installation script:

Expand All @@ -121,10 +121,3 @@ yarn watch
```

By changing the file `'./inst/reactlog/defaultLog.js'` with the contents of any log file in `'./inst/log-files/'`, different default log files can be loaded. Once the local JavaScript (`'./inst/reactlog/reactlogAsset/reactlog.js'`) has been built with `yarn build` or `yarn watch`, refresh `'./inst/reactlog/reactlog.html'` to avoid constantly spawning Shiny applications for testing.


## Guidelines for contributing

We welcome contributions to the **reactlog** package. Please see our [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for detailed guidelines of how to contribute.

Please note that the **reactlog** project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
235 changes: 55 additions & 180 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,99 +1,53 @@
## Cran comments
## CRAN comments

#### 2019-3-18
#### 2020-9-12

Reworded the description and added the DOI mid sentenance in the description.
I kept the name inside the parenthesis to avoid confusion, similar to https://CRAN.R-project.org/package=phyclust.
> 'reactlog' (Schloerke 2019) <doi:10.5281/zenodo.2591517> provides a visual insight into...

Thank you for the change and suggestion!
I've updated the links. Thank you!

Best,
Barret


#### 2019-3-18

> The Description field should start with a capital letter.
Please fix and resubmit.

Is there some reference about the method you can add in the Description
field in the form Authors (year) <doi:.....>?

Best,
Uwe Ligges


#### 2019-3-17

Hello,

Possible invalid URL:
* The README.md URL (http://www.rpackages.io/package/reactlog) is valid once reactlog is on CRAN. The webpage works, just the status is a 404.

Single quote packages:
* Changed `Shiny` to `'shiny'` in the DESCRIPTION file.

Omit stock license file:
* Added the License.md file to `.Rbuildignore`.

Thank you for the changes!

Best,
Barret
#### 2020-9-12

Thanks, we see:


#### 2019-3-17

Thanks,

```
Found the following (possibly) invalid URLs:
URL: http://www.rpackages.io/package/reactlog
URL: https://community.rstudio.com/c/shiny (moved to
https://community.rstudio.com/c/shiny/8)
From: README.md
Status: 404
Message: Not Found


Please always write package names, software names and API names in
single quotes (e.g. 'Shiny') in the Title and the Description field.
Status: 200
Message: OK
URL:
https://resources.rstudio.com/rstudio-conf-2019/reactlog-2-0-debugging-the-state-of-shiny
(moved to
https://rstudio.com/resources/rstudioconf-2019/reactlog-2-0-debugging-the-state-of-shiny/)
From: inst/doc/reactlog.html
Status: 200
Message: OK
URL: https://yarnpkg.com/en/ (moved to https://classic.yarnpkg.com/en/)
From: README.md
Status: 200
Message: OK
URL: https://yarnpkg.com/en/docs/install (moved to
https://classic.yarnpkg.com/en/docs/install)
From: README.md
Status: 200
Message: OK
```

The LICENSE file is only needed if you have additional restrictions to
the GPL-3 which you have not? In that please case omit the file.
Please change http --> https, add trailing slashes, or follow moved
content as appropriate.

Please fix and resubmit.

Best,
Martina Schmirl


#### 2019-3-14

I've reduced the file size and updated the check outputs below.

Thank you for your time!

Best,
Barret


#### 2019-3-14

Thanks, we see:

Size of tarball: 7138666 bytes

Not more than 5 MB for a CRAN package, please.

Best,
Uwe Ligges

#### 2019-9-11

#### 2019-3-14

This is a new release.
I've added new features and bug fixes to reactlog.

Please let me know if there is anything else I can provide.

Expand All @@ -103,117 +57,38 @@ Barret

## R CMD check results

Overall there are no consistent notes or warnings other than the note of `reactlog` being a new submission.

0 errors | 0 warnings | 1 note

* NOTES:
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'
New submission


False positives:
* The 404 README.md URL (http://www.rpackages.io/package/reactlog) is valid once reactlog is on cran. The webpage works, just the status is a 404.
* The WARNING for the README.md conversion on rhub is most likely due to rhub's setup.
* The NOTE for window's old release not converting Authors@R consistently.

0 errors | 0 warnings | 0 notes

## Test environments

#### local OS X install, R 3.5.2
* NOTES:
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'
New submission

Found the following (possibly) invalid URLs:
URL: http://www.rpackages.io/package/reactlog
From: README.md
Status: 404
Message: Not Found
#### ubuntu 14.04 (on travis-ci)

* R 3.4.4 - Status: OK

* R 3.5.2 - Status: OK
* local macOS, R 4.0.0
* GitHub Actions
* macOS
* oldrel, release, devel
* windows
* release
* ubuntu16
* 3.3, 3.4, 3.5, oldrel, release, devel
0 errors ✔ | 0 warnings ✔ | 0 notes ✔

* R Under development (unstable) (2019-03-14 r76237) - Status: OK
* devtools::check_win_devel()


#### win-builder (devel and release)

* R version 3.4.4 (2018-03-15)
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'

New submission

Found the following (possibly) invalid URLs:
URL: http://www.rpackages.io/package/reactlog
From: README.md
Status: 404
Message: Not Found
* checking DESCRIPTION meta-information ... NOTE
Author field differs from that derived from Authors@R
Author: 'Barret Schloerke [aut, cre] (<https://orcid.org/0000-0001-9986-114X>), Joe Cheng [ctb], RStudio [cph, fnd]'
Authors@R: 'Barret Schloerke [aut, cre] (0000-0001-9986-114X), Joe Cheng [ctb], RStudio [cph, fnd]'

* R Under development (unstable) (2019-03-12 r76226)
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'

New submission

Found the following (possibly) invalid URLs:
URL: http://www.rpackages.io/package/reactlog
From: README.md
Status: 404
Message: Not Found

* R version 3.5.3 (2019-03-11)
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'

New submission

Found the following (possibly) invalid URLs:
URL: http://www.rpackages.io/package/reactlog
From: README.md
Status: 404
Message: Not Found
#### rhub

* Build ID: reactlog_1.0.0.tar.gz-8f10a076c4d543ee935621494de204a2
Platform: Windows Server 2008 R2 SP1, R-devel, 32/64 bit
R Under development (unstable) (2019-03-09 r76216)
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'
Maintainer: 'Barret Schloerke <barret@rstudio.com>'

New submission
Possibly mis-spelled words in DESCRIPTION:
Reactivity (2:8)
Schloerke (15:4)
reactivity (16:29)
Status: 1 NOTE

* Build ID: reactlog_1.0.0.tar.gz-61464674f5894f2aafbdeb08cde4398e
Platform: Windows Server 2008 R2 SP1, R-release, 32/64 bit
R version 3.5.3 (2019-03-11)
* checking CRAN incoming feasibility ... NOTE
Maintainer: 'Barret Schloerke <barret@rstudio.com>'
New submission

* Build ID: reactlog_1.0.0.tar.gz-6f17d96a1158459d9d1a673bdf970a3d
Platform: Ubuntu Linux 16.04 LTS, R-release, GCC
R version 3.5.3 (2019-03-11) -- "Great Truth"
* checking top-level files ... WARNING
Conversion of ‘README.md’ failed:
(ConnectionFailure getProtocolByName: does not exist (no such protocol name: tcp))
* checking CRAN incoming feasibility ... NOTE
Maintainer: ‘Barret Schloerke <barret@rstudio.com>
* I believe spellings these are false positives.
* `Schloerke` is my last name
* `reactivity` is a word we use to describe how reactive values work within 'shiny'.

New submission
## revdepcheck results

* Build ID: reactlog_1.0.0.tar.gz-ce002ac23eac49d0bf288412970c2627
Platform: Fedora Linux, R-devel, clang, gfortran
R Under development (unstable) (2019-03-13 r76230) -- "Unsuffered Consequences"
* checking CRAN incoming feasibility ... NOTE
Maintainer: ‘Barret Schloerke <barret@rstudio.com>
We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

New submission
* We saw 0 new problems
* We failed to check 0 packages
2 changes: 1 addition & 1 deletion man/reactlog_module.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions revdep/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
checks
library
checks.noindex
library.noindex
data.sqlite
*.html

0 comments on commit 31c519d

Please sign in to comment.