Skip to content

Commit

Permalink
fix moved urls in the vignette and removed Inkscape link (as we have …
Browse files Browse the repository at this point in the history
…not been using the hex sticker for a long while now)
  • Loading branch information
s-fleck authored and Stefan Fleck committed Oct 20, 2020
1 parent 79020eb commit d60bf9b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: lgr
Title: A Fully Featured Logging Framework
Version: 0.4.0
Version: 0.4.1
Authors@R:
person(given = "Stefan",
family = "Fleck",
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# lgr 0.4.0
# lgr 0.4.1

* Moved more complex Appenders to package
[lgrExtra](https://github.com/s-fleck/lgrExtra). This includes database
Expand Down
5 changes: 2 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Loggers a bit strange and verbose, but care was taken to keep
the syntax for common logging tasks and interactive usage simple and concise.
User that have experience with
[shiny](https://github.com/rstudio/shiny),
[plumber](https://github.com/trestletech/plumber),
[plumber](https://github.com/rstudio/plumber),
[python logging](https://docs.python.org/3/library/logging.html) or
[Apache Log4j](https://logging.apache.org/log4j/2.x/) will feel
at home. User that are proficient with R6 classes will also find it easy
Expand Down Expand Up @@ -257,5 +257,4 @@ request on the issue tracker.

## Acknowledgement

* [Inkscape](https://inkscape.org/) for the hex sticker
* [draw.io](https://draw.io/) for the flow chart in the vignette
* [diagrams.net](https://app.diagrams.net/) for the flow chart in the vignette
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Users that have not worked with R6 classes before, will find configuring
Loggers a bit strange and verbose, but care was taken to keep the syntax
for common logging tasks and interactive usage simple and concise. User
that have experience with [shiny](https://github.com/rstudio/shiny),
[plumber](https://github.com/trestletech/plumber), [python
[plumber](https://github.com/rstudio/plumber), [python
logging](https://docs.python.org/3/library/logging.html) or [Apache
Log4j](https://logging.apache.org/log4j/2.x/) will feel at home. User
that are proficient with R6 classes will also find it easy to extend and
Expand Down Expand Up @@ -65,13 +65,13 @@ vignette.

``` r
lgr$fatal("A critical error")
#> FATAL [10:55:49.023] A critical error
#> FATAL [17:25:32.336] A critical error
lgr$error("A less severe error")
#> ERROR [10:55:49.145] A less severe error
#> ERROR [17:25:32.401] A less severe error
lgr$warn("A potentially bad situation")
#> WARN [10:55:49.202] A potentially bad situation
#> WARN [17:25:32.421] A potentially bad situation
lgr$info("iris has %s rows", nrow(iris))
#> INFO [10:55:49.217] iris has 150 rows
#> INFO [17:25:32.425] iris has 150 rows

# the following log levels are hidden by default
lgr$debug("A debug message")
Expand All @@ -85,9 +85,9 @@ appender to log to a file with little effort.
tf <- tempfile()
lgr$add_appender(AppenderFile$new(tf, layout = LayoutJson$new()))
lgr$info("cars has %s rows", nrow(cars))
#> INFO [10:55:49.270] cars has 50 rows
#> INFO [17:25:32.458] cars has 50 rows
cat(readLines(tf))
#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"cars has 50 rows"}
#> {"level":400,"timestamp":"2020-10-17 17:25:32","logger":"root","caller":"eval","msg":"cars has 50 rows"}
```

By passing a named argument to `info()`, `warn()`, and co you can log
Expand All @@ -97,10 +97,10 @@ logfiles that are machine as well as (somewhat) human readable.

``` r
lgr$info("loading cars", "cars", rows = nrow(cars), cols = ncol(cars))
#> INFO [10:55:49.322] loading cars {rows: 50, cols: 2}
#> INFO [17:25:32.502] loading cars {rows: 50, cols: 2}
cat(readLines(tf), sep = "\n")
#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"cars has 50 rows"}
#> {"level":400,"timestamp":"2020-10-17 10:55:49","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
#> {"level":400,"timestamp":"2020-10-17 17:25:32","logger":"root","caller":"eval","msg":"cars has 50 rows"}
#> {"level":400,"timestamp":"2020-10-17 17:25:32","logger":"root","caller":"eval","msg":"loading cars","rows":50,"cols":2}
```

For more examples please see the package
Expand Down Expand Up @@ -243,5 +243,5 @@ to post a feature request on the issue tracker.

## Acknowledgement

- [Inkscape](https://inkscape.org/) for the hex sticker
- [draw.io](https://draw.io/) for the flow chart in the vignette
- [diagrams.net](https://app.diagrams.net/) for the flow chart in the
vignette
3 changes: 3 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@

Major update (see NEWS.md). Fixes CRAN check errors that are due to a breaking
update in the companion-package rotor.


**resubmission:** fixed some outdated URLs that have moved

0 comments on commit d60bf9b

Please sign in to comment.