Skip to content

Commit cc29724

Browse files
committed
Deploying to gh-pages from @ 976d2b0 🚀
1 parent 7b933af commit cc29724

76 files changed

Lines changed: 466 additions & 123 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

CODE_OF_CONDUCT.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE-text.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

authors.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

authors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Source:
2323
[`DESCRIPTION`](https://github.com/WangLabCSU/rpkgkit/blob/main/DESCRIPTION)
2424

2525
Yang Y, Scott J, Hernangómez D (2026). *rpkgkit: Create and Maintain R
26-
Packages*. R package version 0.1.3,
26+
Packages*. R package version 0.1.4,
2727
<https://github.com/WangLabCSU/rpkgkit>.
2828

2929
@Manual{,
3030
title = {rpkgkit: Create and Maintain R Packages},
3131
author = {Yuxi Yang and Jacob Scott and Diego Hernangómez},
3232
year = {2026},
33-
note = {R package version 0.1.3},
33+
note = {R package version 0.1.4},
3434
url = {https://github.com/WangLabCSU/rpkgkit},
3535
}

index.html

Lines changed: 85 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.md

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ update_time_in_standalone()
208208
```
209209

210210
- [`add_changelog_in_standalone()`](https://wanglabcsu.github.io/rpkgkit/reference/add_changelog_in_standalone.md) -
211-
Add changelog entries to standalone files
211+
Add changelog entries to standalone files.
212212

213213
``` r
214214

@@ -235,13 +235,39 @@ add_changelog_in_standalone("R/standalone-foo.R", "Added foo function")
235235
Add new entries to NEWS.md following CRAN guidelines
236236

237237
``` r
238+
238239
news_md_add_entry("Added foo function")
240+
```
241+
242+
``` R
243+
# rpkgkit 0.0.4 (2026-06-02)
244+
245+
## NEW FEATURES
246+
247+
* Added foo function
248+
```
239249

250+
Add a different entry
251+
252+
``` r
253+
254+
news_md_add_entry(
255+
entry = "Fixed bugs in `foo()`",
256+
version = "0.0.4",
257+
category = "BUG FIXES"
258+
)
259+
```
260+
261+
``` R
240262
# rpkgkit 0.0.4 (2026-06-02)
241263

242264
## NEW FEATURES
243265

244266
* Added foo function
267+
268+
## BUG FIXES
269+
270+
* Fixed bugs in `foo()`
245271
```
246272

247273
- [`news_md_check()`](https://wanglabcsu.github.io/rpkgkit/reference/news_md.md) -
@@ -393,11 +419,31 @@ cat(readLines(tf), sep = "\n")
393419
# message('Hello, world')
394420
```
395421

422+
- [`convert_func_syntax()`](https://wanglabcsu.github.io/rpkgkit/reference/convert_func_syntax.md) -
423+
Convert function syntax between `function()` and `\()`
424+
425+
``` r
426+
427+
f <- tempfile(fileext = ".R")
428+
writeLines("f <- function(x) x^2", f)
429+
convert_func_syntax(f)
430+
# ✔ Converted function definitions in /tmp/Rtmp9ftJDS/file2a5a1320c9342e.R to "to_lambda"
431+
message(readLines(f), sep = "\n")
432+
# f <- \(x) x^2
433+
434+
convert_func_syntax(f, "to_explicit")
435+
# ✔ Converted function definitions in /tmp/Rtmp9ftJDS/file2a5a1320c9342e.R to "to_explicit"
436+
message(readLines(f), sep = "\n")
437+
# f <- function(x) x^2
438+
```
439+
396440
### R Package Maintenance
397441

398442
- [`use_zzz()`](https://wanglabcsu.github.io/rpkgkit/reference/use_zzz.md) -
399-
Create `zzz.R` file in `R/` folder, with `.onLoad`, `.onAttach`, and
400-
package description
443+
Create `{pkgname}-package.R` file in `R/` folder, with `.onLoad`,
444+
`.onAttach`, `%||%` and package description. Similar to
445+
[`usethis::use_package_doc()`](https://usethis.r-lib.org/reference/use_package_doc.html)
446+
but more powerful.
401447

402448
``` r
403449

@@ -435,6 +481,13 @@ use_zzz()
435481
# .onLoad <- function(libname, pkgname) {
436482
# invisible()
437483
# }
484+
485+
# `%||%` <- function(left, right) {
486+
# if (is.null(left)) {
487+
# return(right)
488+
# }
489+
# left
490+
# }
438491
```
439492

440493
- [`check_pkgdown_reference()`](https://wanglabcsu.github.io/rpkgkit/reference/check_pkgdown_reference.md) -
@@ -486,6 +539,30 @@ use_vendor(pkg = "WangLabCSU/rpkgkit", "43_use_vendor.R", branch = "main", path
486539
# - The authors of the [rpkgkit](https://github.com/WangLabCSU/rpkgkit) package &mdash; **Yuxi Yang, Jacob Scott, Christopher T. Kenny, Sebastian Lammers and Diego Hernangómez** &mdash; whose code is included (under MIT license) in `R/vendor-rpkgkit.R`.
487540
```
488541

542+
- [`use_multilanguage_readme()`](https://wanglabcsu.github.io/rpkgkit/reference/use_multilanguage_readme.md) -
543+
Create a multi-language README.md template for your R package.
544+
- [`badge_translated_by_ai()`](https://wanglabcsu.github.io/rpkgkit/reference/badge_translated_by_ai.md) -
545+
Create a badge for translated by AI.
546+
547+
``` r
548+
549+
use_multilangauge_readme("es")
550+
# ✔ Created 1 README translation file in inst/translations.
551+
# ☐ Consider pasting the following badges into your main README.md:
552+
553+
# [![Español](https://img.shields.io/badge/README-Espa%C3%B1ol-blue)](inst/translations/README.es.md)
554+
```
555+
556+
``` r
557+
558+
badge_translated_by_ai("es")
559+
# ☐ Consider copying the following statement to the AI-translated file(s):
560+
561+
# [![AI](https://img.shields.io/badge/AI-Espa%C3%B1ol-yellow)]()
562+
563+
# > Este contenido ha sido traducido por IA y no ha sido revisado. No es la lengua materna del autor y es solo para referencia.
564+
```
565+
489566
## Acknowledgements
490567

491568
We would like to thank the following people and projects:

llms.txt

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ update_time_in_standalone()
208208
```
209209

210210
- [`add_changelog_in_standalone()`](https://wanglabcsu.github.io/rpkgkit/reference/add_changelog_in_standalone.md) -
211-
Add changelog entries to standalone files
211+
Add changelog entries to standalone files.
212212

213213
``` r
214214

@@ -235,13 +235,39 @@ add_changelog_in_standalone("R/standalone-foo.R", "Added foo function")
235235
Add new entries to NEWS.md following CRAN guidelines
236236

237237
``` r
238+
238239
news_md_add_entry("Added foo function")
240+
```
241+
242+
``` R
243+
# rpkgkit 0.0.4 (2026-06-02)
244+
245+
## NEW FEATURES
246+
247+
* Added foo function
248+
```
239249

250+
Add a different entry
251+
252+
``` r
253+
254+
news_md_add_entry(
255+
entry = "Fixed bugs in `foo()`",
256+
version = "0.0.4",
257+
category = "BUG FIXES"
258+
)
259+
```
260+
261+
``` R
240262
# rpkgkit 0.0.4 (2026-06-02)
241263

242264
## NEW FEATURES
243265

244266
* Added foo function
267+
268+
## BUG FIXES
269+
270+
* Fixed bugs in `foo()`
245271
```
246272

247273
- [`news_md_check()`](https://wanglabcsu.github.io/rpkgkit/reference/news_md.md) -
@@ -393,11 +419,31 @@ cat(readLines(tf), sep = "\n")
393419
# message('Hello, world')
394420
```
395421

422+
- [`convert_func_syntax()`](https://wanglabcsu.github.io/rpkgkit/reference/convert_func_syntax.md) -
423+
Convert function syntax between `function()` and `\()`
424+
425+
``` r
426+
427+
f <- tempfile(fileext = ".R")
428+
writeLines("f <- function(x) x^2", f)
429+
convert_func_syntax(f)
430+
# ✔ Converted function definitions in /tmp/Rtmp9ftJDS/file2a5a1320c9342e.R to "to_lambda"
431+
message(readLines(f), sep = "\n")
432+
# f <- \(x) x^2
433+
434+
convert_func_syntax(f, "to_explicit")
435+
# ✔ Converted function definitions in /tmp/Rtmp9ftJDS/file2a5a1320c9342e.R to "to_explicit"
436+
message(readLines(f), sep = "\n")
437+
# f <- function(x) x^2
438+
```
439+
396440
### R Package Maintenance
397441

398442
- [`use_zzz()`](https://wanglabcsu.github.io/rpkgkit/reference/use_zzz.md) -
399-
Create `zzz.R` file in `R/` folder, with `.onLoad`, `.onAttach`, and
400-
package description
443+
Create `{pkgname}-package.R` file in `R/` folder, with `.onLoad`,
444+
`.onAttach`, `%||%` and package description. Similar to
445+
[`usethis::use_package_doc()`](https://usethis.r-lib.org/reference/use_package_doc.html)
446+
but more powerful.
401447

402448
``` r
403449

@@ -435,6 +481,13 @@ use_zzz()
435481
# .onLoad <- function(libname, pkgname) {
436482
# invisible()
437483
# }
484+
485+
# `%||%` <- function(left, right) {
486+
# if (is.null(left)) {
487+
# return(right)
488+
# }
489+
# left
490+
# }
438491
```
439492

440493
- [`check_pkgdown_reference()`](https://wanglabcsu.github.io/rpkgkit/reference/check_pkgdown_reference.md) -
@@ -486,6 +539,30 @@ use_vendor(pkg = "WangLabCSU/rpkgkit", "43_use_vendor.R", branch = "main", path
486539
# - The authors of the [rpkgkit](https://github.com/WangLabCSU/rpkgkit) package &mdash; **Yuxi Yang, Jacob Scott, Christopher T. Kenny, Sebastian Lammers and Diego Hernangómez** &mdash; whose code is included (under MIT license) in `R/vendor-rpkgkit.R`.
487540
```
488541

542+
- [`use_multilanguage_readme()`](https://wanglabcsu.github.io/rpkgkit/reference/use_multilanguage_readme.md) -
543+
Create a multi-language README.md template for your R package.
544+
- [`badge_translated_by_ai()`](https://wanglabcsu.github.io/rpkgkit/reference/badge_translated_by_ai.md) -
545+
Create a badge for translated by AI.
546+
547+
``` r
548+
549+
use_multilangauge_readme("es")
550+
# ✔ Created 1 README translation file in inst/translations.
551+
# ☐ Consider pasting the following badges into your main README.md:
552+
553+
# [![Español](https://img.shields.io/badge/README-Espa%C3%B1ol-blue)](inst/translations/README.es.md)
554+
```
555+
556+
``` r
557+
558+
badge_translated_by_ai("es")
559+
# ☐ Consider copying the following statement to the AI-translated file(s):
560+
561+
# [![AI](https://img.shields.io/badge/AI-Espa%C3%B1ol-yellow)]()
562+
563+
# > Este contenido ha sido traducido por IA y no ha sido revisado. No es la lengua materna del autor y es solo para referencia.
564+
```
565+
489566
## Acknowledgements
490567

491568
We would like to thank the following people and projects:

news/index.html

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)