Skip to content

Commit

Permalink
regenerate README, docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fmichonneau committed Jul 22, 2020
1 parent b4fbb65 commit 7a0ad3d
Show file tree
Hide file tree
Showing 22 changed files with 111 additions and 110 deletions.
2 changes: 1 addition & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ man-roxygen
^.pre-commit-config.yaml$
^pkgdown$
^CRAN-RELEASE$
^revdep
^revdep
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ R session to know the results of the CRAN checks for your packages.
You can install the development version of **`foghorn`** from github with:

```{r gh-installation, eval = FALSE}
source("https://install-github.me/fmichonneau/foghorn")
remotes::install_github("fmichonneau/foghorn")
```

or the stable version from CRAN:
Expand Down
55 changes: 25 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can install the development version of **`foghorn`** from github
with:

``` r
source("https://install-github.me/fmichonneau/foghorn")
remotes::install_github("fmichonneau/foghorn")
```

or the stable version from CRAN:
Expand Down Expand Up @@ -65,10 +65,8 @@ this result.
## Graphical interface
summary_cran_results(email = "[email protected]")
#> ✔ All clear for foghorn, phylobase, riceware, rotl!
#> ⚠ Package with warnings on CRAN:
#> - rncl (4)
#> ★ Package with notes on CRAN:
#> - rncl (3)
#> - rncl (2)
```

`summary_cran_results()` is actually an alias of
Expand All @@ -82,11 +80,11 @@ cran_results(email = "[email protected]")
#> # A tibble: 5 x 7
#> package error fail warn note ok has_other_issues
#> <chr> <int> <int> <int> <int> <int> <lgl>
#> 1 foghorn 0 0 0 0 12 FALSE
#> 2 phylobase 0 0 0 0 12 FALSE
#> 3 riceware 0 0 0 0 12 FALSE
#> 4 rncl 0 0 4 3 5 FALSE
#> 5 rotl 0 0 0 0 12 FALSE
#> 1 foghorn 0 0 0 0 11 FALSE
#> 2 phylobase 0 0 0 0 11 FALSE
#> 3 riceware 0 0 0 0 11 FALSE
#> 4 rncl 0 0 0 2 9 FALSE
#> 5 rotl 0 0 0 0 11 FALSE
```

In addition of your own packages, you can also check the results for any
Expand All @@ -95,29 +93,27 @@ other packages that might be of interest to you:
``` r
## either by themselves
summary_cran_results(pkg = c("ggplot2", "dplyr"))
#> ⚠ Package with warnings on CRAN:
#> - ggplot2 (4)
#> ★ Packages with notes on CRAN:
#> - dplyr (8)
#> - dplyr (4)
#> - ggplot2 (4)
#> ◉ Package with other issues on CRAN:
#> - dplyr

cran_results(pkg = c("ggplot2", "dplyr"))
#> # A tibble: 2 x 7
#> package error fail warn note ok has_other_issues
#> <chr> <int> <int> <int> <int> <int> <lgl>
#> 1 dplyr 0 0 0 8 4 FALSE
#> 2 ggplot2 0 0 4 4 4 FALSE
#> 1 dplyr 0 0 0 4 7 TRUE
#> 2 ggplot2 0 0 0 4 7 FALSE

## or by combining them with email addresses
summary_cran_results(
email = "[email protected]",
pkg = c("mregions", "ridigbio")
)
#> ✔ All clear for foghorn, mregions, phylobase, riceware, ridigbio, rotl!
#> ⚠ Package with warnings on CRAN:
#> - rncl (4)
#> ★ Package with notes on CRAN:
#> - rncl (3)
#> - rncl (2)

cran_results(
email = "[email protected]",
Expand All @@ -126,13 +122,13 @@ cran_results(
#> # A tibble: 7 x 7
#> package error fail warn note ok has_other_issues
#> <chr> <int> <int> <int> <int> <int> <lgl>
#> 1 foghorn 0 0 0 0 12 FALSE
#> 2 mregions 0 0 0 0 12 FALSE
#> 3 phylobase 0 0 0 0 12 FALSE
#> 4 riceware 0 0 0 0 12 FALSE
#> 5 ridigbio 0 0 0 0 12 FALSE
#> 6 rncl 0 0 4 3 5 FALSE
#> 7 rotl 0 0 0 0 12 FALSE
#> 1 foghorn 0 0 0 0 11 FALSE
#> 2 mregions 0 0 0 0 11 FALSE
#> 3 phylobase 0 0 0 0 11 FALSE
#> 4 riceware 0 0 0 0 11 FALSE
#> 5 ridigbio 0 0 0 0 11 FALSE
#> 6 rncl 0 0 0 2 9 FALSE
#> 7 rotl 0 0 0 0 11 FALSE
```

You can inspect the logs for the check results using
Expand All @@ -142,16 +138,15 @@ You can inspect the logs for the check results using
``` r
(tidyr_checks <- cran_details(pkg = "tidyr"))
#> # A tibble: 1 x 7
#> package version result check flavors n_flavors message
#> <chr> <chr> <chr> <chr> <chr> <dbl> <chr>
#> 1 tidyr 1.0.0 NOTE data for… r-devel-linux-x85 " Note:…
#> package version result check flavors n_flavors message
#> <chr> <chr> <chr> <chr> <chr> <dbl> <chr>
#> 1 tidyr 1.1.0 NOTE data for … r-devel-linux-x86_64 " Note:
summary(tidyr_checks)
#> ★ tidyr - note: data for non-ASCII characters
#> ❯ r-devel-linux-x86_64-fedora-clang
#> ❯ r-devel-linux-x86_64-fedora-gcc
#> ❯ r-patched-solaris-x86
#> ❯ r-release-osx-x86_64
#> ❯ r-oldrel-osx-x86_64
#> ❯ r-oldrel-macos-x86_64
#>
#> Note: found 24 marked UTF-8 strings
```
Expand All @@ -171,7 +166,7 @@ cran_results(pkg = "nlme", src = "crandb", progress = FALSE)
#> # A tibble: 1 x 7
#> package error fail warn note ok has_other_issues
#> <chr> <int> <int> <int> <int> <int> <lgl>
#> 1 nlme 1 0 0 0 11 FALSE
#> 1 nlme 0 0 0 0 11 FALSE
```

Check out the “Details” section in the help files for more information.
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

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

2 changes: 1 addition & 1 deletion docs/CODE_OF_CONDUCT.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

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

49 changes: 24 additions & 25 deletions docs/articles/foghorn.html

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

12 changes: 12 additions & 0 deletions docs/articles/foghorn_files/header-attrs-2.3/header-attrs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Pandoc 2.9 adds attributes on both header and div. We remove the former (to
// be compatible with the behavior of Pandoc < 2.8).
document.addEventListener('DOMContentLoaded', function(e) {
var hs = document.querySelectorAll("div.section[class*='level'] > :first-child");
var i, h, a;
for (i = 0; i < hs.length; i++) {
h = hs[i];
if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6
a = h.attributes;
while (a.length > 0) h.removeAttribute(a[0].name);
}
});
2 changes: 1 addition & 1 deletion docs/articles/index.html

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

2 changes: 1 addition & 1 deletion docs/authors.html

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

Loading

0 comments on commit 7a0ad3d

Please sign in to comment.