Skip to content

Commit 0f83211

Browse files
committed
rename code of conduct file, fix links
1 parent 7508583 commit 0f83211

File tree

5 files changed

+76
-66
lines changed

5 files changed

+76
-66
lines changed
File renamed without changes.

README.Rmd

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,15 @@ summary_cran_results(pkg = c("ggplot2", "dplyr"))
8181
cran_results(pkg = c("ggplot2", "dplyr"))
8282
8383
## or by combining them with email addresses
84-
summary_cran_results(email = "francois.michonneau@gmail.com",
85-
pkg = c("mregions", "ridigbio"))
84+
summary_cran_results(
85+
email = "francois.michonneau@gmail.com",
86+
pkg = c("mregions", "ridigbio")
87+
)
8688
87-
cran_results(email = "francois.michonneau@gmail.com",
88-
pkg = c("mregions", "ridigbio"))
89+
cran_results(
90+
email = "francois.michonneau@gmail.com",
91+
pkg = c("mregions", "ridigbio")
92+
)
8993
```
9094

9195
You can inspect the logs for the check results using
@@ -106,7 +110,7 @@ packages, using the CRAN database is recommended (it's about 20Mb of data). To
106110
use the CRAN database, add `src = "crandb"` in your function calls:
107111

108112
```{r show-cran-db}
109-
cran_results(pkg = "nlme", src = "crandb")
113+
cran_results(pkg = "nlme", src = "crandb", progress = FALSE)
110114
```
111115

112116
Check out the "Details" section in the help files for more information.
@@ -122,5 +126,5 @@ GitHub.
122126
## Code of Conduct
123127

124128
Please note that this project is released with
125-
a [Contributor Code of Conduct](CONDUCT.md). By participating in this project
129+
a [Contributor Code of Conduct](https://fmichonneau.github.io/foghorn/CODE_OF_CONDUCT.html). By participating in this project
126130
you agree to abide by its terms.

README.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,9 @@ this result.
6464
``` r
6565
## Graphical interface
6666
summary_cran_results(email = "francois.michonneau@gmail.com")
67-
#> ✔ All clear for foghorn, phylobase, riceware!
68-
#> ⚠ Packages with warnings on CRAN:
69-
#> - rncl (2)
70-
#> - rotl (3)
67+
#> ✔ All clear for foghorn, phylobase, riceware, rotl!
68+
#> ⚠ Package with warnings on CRAN:
69+
#> - rncl (4)
7170
#> ★ Package with notes on CRAN:
7271
#> - rncl (3)
7372
```
@@ -86,8 +85,8 @@ cran_results(email = "francois.michonneau@gmail.com")
8685
#> 1 foghorn 0 0 0 0 12 FALSE
8786
#> 2 phylobase 0 0 0 0 12 FALSE
8887
#> 3 riceware 0 0 0 0 12 FALSE
89-
#> 4 rncl 0 0 2 3 7 FALSE
90-
#> 5 rotl 0 0 3 0 9 FALSE
88+
#> 4 rncl 0 0 4 3 5 FALSE
89+
#> 5 rotl 0 0 0 0 12 FALSE
9190
```
9291

9392
In addition of your own packages, you can also check the results for any
@@ -97,30 +96,33 @@ other packages that might be of interest to you:
9796
## either by themselves
9897
summary_cran_results(pkg = c("ggplot2", "dplyr"))
9998
#> ⚠ Package with warnings on CRAN:
100-
#> - ggplot2 (3)
99+
#> - ggplot2 (4)
101100
#> ★ Packages with notes on CRAN:
102101
#> - dplyr (8)
103-
#> - ggplot2 (5)
102+
#> - ggplot2 (4)
104103

105104
cran_results(pkg = c("ggplot2", "dplyr"))
106105
#> # A tibble: 2 x 7
107106
#> package error fail warn note ok has_other_issues
108107
#> <chr> <int> <int> <int> <int> <int> <lgl>
109108
#> 1 dplyr 0 0 0 8 4 FALSE
110-
#> 2 ggplot2 0 0 3 5 4 FALSE
109+
#> 2 ggplot2 0 0 4 4 4 FALSE
111110

112111
## or by combining them with email addresses
113-
summary_cran_results(email = "francois.michonneau@gmail.com",
114-
pkg = c("mregions", "ridigbio"))
115-
#> ✔ All clear for foghorn, mregions, phylobase, riceware, ridigbio!
116-
#> ⚠ Packages with warnings on CRAN:
117-
#> - rncl (2)
118-
#> - rotl (3)
112+
summary_cran_results(
113+
email = "francois.michonneau@gmail.com",
114+
pkg = c("mregions", "ridigbio")
115+
)
116+
#> ✔ All clear for foghorn, mregions, phylobase, riceware, ridigbio, rotl!
117+
#> ⚠ Package with warnings on CRAN:
118+
#> - rncl (4)
119119
#> ★ Package with notes on CRAN:
120120
#> - rncl (3)
121121

122-
cran_results(email = "francois.michonneau@gmail.com",
123-
pkg = c("mregions", "ridigbio"))
122+
cran_results(
123+
email = "francois.michonneau@gmail.com",
124+
pkg = c("mregions", "ridigbio")
125+
)
124126
#> # A tibble: 7 x 7
125127
#> package error fail warn note ok has_other_issues
126128
#> <chr> <int> <int> <int> <int> <int> <lgl>
@@ -129,8 +131,8 @@ cran_results(email = "francois.michonneau@gmail.com",
129131
#> 3 phylobase 0 0 0 0 12 FALSE
130132
#> 4 riceware 0 0 0 0 12 FALSE
131133
#> 5 ridigbio 0 0 0 0 12 FALSE
132-
#> 6 rncl 0 0 2 3 7 FALSE
133-
#> 7 rotl 0 0 3 0 9 FALSE
134+
#> 6 rncl 0 0 4 3 5 FALSE
135+
#> 7 rotl 0 0 0 0 12 FALSE
134136
```
135137

136138
You can inspect the logs for the check results using
@@ -142,7 +144,7 @@ You can inspect the logs for the check results using
142144
#> # A tibble: 1 x 7
143145
#> package version result check flavors n_flavors message
144146
#> <chr> <chr> <chr> <chr> <chr> <dbl> <chr>
145-
#> 1 tidyr 0.8.2 NOTE data for… r-devel-linux-x8… 5 " Note:…
147+
#> 1 tidyr 1.0.0 NOTE data for… r-devel-linux-x8… 5 " Note:…
146148
summary(tidyr_checks)
147149
#> ★ tidyr - note: data for non-ASCII characters
148150
#> ❯ r-devel-linux-x86_64-fedora-clang
@@ -151,7 +153,7 @@ summary(tidyr_checks)
151153
#> ❯ r-release-osx-x86_64
152154
#> ❯ r-oldrel-osx-x86_64
153155
#>
154-
#> Note: found 23 marked UTF-8 strings
156+
#> Note: found 24 marked UTF-8 strings
155157
```
156158

157159
## Where does the data come from?
@@ -165,11 +167,11 @@ on a large number of packages, using the CRAN database is recommended
165167
"crandb"` in your function calls:
166168

167169
``` r
168-
cran_results(pkg = "nlme", src = "crandb")
170+
cran_results(pkg = "nlme", src = "crandb", progress = FALSE)
169171
#> # A tibble: 1 x 7
170172
#> package error fail warn note ok has_other_issues
171173
#> <chr> <int> <int> <int> <int> <int> <lgl>
172-
#> 1 nlme 0 0 0 0 12 FALSE
174+
#> 1 nlme 1 0 0 0 11 FALSE
173175
```
174176

175177
Check out the “Details” section in the help files for more information.
@@ -182,5 +184,5 @@ issue](https://github.com/fmichonneau/foghorn/issues/new) on GitHub.
182184
## Code of Conduct
183185

184186
Please note that this project is released with a [Contributor Code of
185-
Conduct](CONDUCT.md). By participating in this project you agree to
186-
abide by its terms.
187+
Conduct](https://fmichonneau.github.io/foghorn/CODE_OF_CONDUCT.html). By
188+
participating in this project you agree to abide by its terms.

0 commit comments

Comments
 (0)