Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option for auto creation of inst/CITATION #84

Merged
merged 3 commits into from
Jan 18, 2025
Merged

Conversation

dieghernan
Copy link
Member

@dieghernan dieghernan commented Jan 17, 2025

Description

New parameter r_citation in cff_write(). When it is set to TRUE a
R citation file (inst/CITATION) would be generated/updated with the
information of the generated CITATION.cff file. No backup copy would be
created

Related Issue

Close #79

Example

Use case:

cff_write(r_citation = TRUE)

What do you think @roaldarbol @njtierney?

Copy link

codecov bot commented Jan 17, 2025

❌ 2 Tests Failed:

Tests completed Failed Passed Skipped
188 2 186 0
View the full list of 2 ❄️ flaky tests
deprecated cff_extract_to_bibtex

Flake rate in main: 37.50% (Passed 10 times, Failed 6 times)

Stack Traces | 0.026s run time
Error in `cff_create("cffr")`: `x` not valid. If it is a package you may need to install it with `install.packages()`.
Backtrace:
    x
 1. \-cffr::cff_create("cffr") at test-deprecated.R:2:3
 2.   \-cli::cli_abort(paste0("{.arg x} not valid. ", msg_hint)) at cffr/R/cff_create.R:131:5
 3.     \-rlang::abort(...)
deprecated cff_to_bibtex

Flake rate in main: 37.50% (Passed 10 times, Failed 6 times)

Stack Traces | 0.063s run time
Error in `cff_create("cffr")`: `x` not valid. If it is a package you may need to install it with `install.packages()`.
Backtrace:
    x
 1. \-cffr::cff_create("cffr") at test-deprecated.R:11:3
 2.   \-cli::cli_abort(paste0("{.arg x} not valid. ", msg_hint)) at cffr/R/cff_create.R:131:5
 3.     \-rlang::abort(...)

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

@roaldarbol
Copy link

Looks good to me!

@dieghernan dieghernan merged commit 8ded758 into main Jan 18, 2025
17 checks passed
@dieghernan dieghernan deleted the autocitation branch January 18, 2025 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Automated generation of inst/CITATION
2 participants