Skip to content

Commit

Permalink
Prepare for CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Sep 23, 2022
1 parent 0f55036 commit 0d16a47
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 14 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/pkgcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ on:
push:
branches:
- main
- master

jobs:
check:
pkgcheck:
runs-on: ubuntu-latest
steps:
- uses: ropensci-review-tools/pkgcheck-action@main
with:
post-to-issue: false
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.2.3.9000
# CITATION file created with {cffr} R package, v0.3.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------

Expand All @@ -8,7 +8,7 @@ message: 'To cite package "cffr" in publications use:'
type: software
license: GPL-3.0-or-later
title: 'cffr: Generate Citation File Format (''cff'') Metadata for R Packages'
version: 0.2.3.9000
version: 0.3.0
doi: 10.21105/joss.03900
abstract: The Citation File Format version 1.2.0 <doi:10.5281/zenodo.5171937> is a
human and machine readable file format which provides citation metadata for software.
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: cffr
Title: Generate Citation File Format ('cff') Metadata for R Packages
Version: 0.2.3.9000
Version: 0.3.0
Authors@R: c(
person("Diego", "Hernangómez", , "diego.hernangomezherrero@gmail.com", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0001-8457-4658")),
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# cffr (development version)
# cffr 0.3.0

- `preferred-citation` is only produced when a CITATION (**R**) file has been
provided with the package (#37).
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ included full support of this citation format ([Druskat
2021](#ref-druskat_stephan_making_2021)). GitHub support is of special
interest:

<img src="vignettes/tweet-1.png" title="GitHub-link" alt="GitHub-link" width="400" style="display: block; margin: auto;" />
<img src="vignettes/tweet-1.png" alt="GitHub-link" width="400" style="display: block; margin: auto;" />

*— Nat Friedman (@natfriedman) [July 27,
2021](https://twitter.com/natfriedman/status/1420122675813441540?ref_src=twsrc%5Etfw)*
Expand Down Expand Up @@ -71,7 +71,7 @@ file and the `CITATION` file (if present) of your package. Note that
**cffr** works best if your package pass
`R CMD check/devtools::check()`.

As per 2022-08-29 there are at least 207 repos on GitHub using **cffr**.
As per 2022-09-23 there are at least 211 repos on GitHub using **cffr**.
[Check them out
here](https://github.com/search?l=&o=desc&q=cffr+extension%3Acff+filename%3ACITATION&s=indexed&type=Code).

Expand Down Expand Up @@ -146,7 +146,7 @@ test <- cff_create("rmarkdown")
type: software
license: GPL-3.0-only
title: 'rmarkdown: Dynamic Documents for R'
version: '2.15'
version: '2.16'
abstract: Convert R Markdown documents into a variety of formats.
authors:
- family-names: Allaire
Expand Down Expand Up @@ -218,12 +218,12 @@ test <- cff_create("rmarkdown")
email: rich@rstudio.com
orcid: https://orcid.org/0000-0003-3925-190X
year: '2022'
notes: R package version 2.15
notes: R package version 2.16
url: https://github.com/rstudio/rmarkdown
repository: https://CRAN.R-project.org/package=rmarkdown
repository-code: https://github.com/rstudio/rmarkdown
url: https://pkgs.rstudio.com/rmarkdown/
date-released: '2022-08-16'
date-released: '2022-08-24'
contact:
- family-names: Xie
given-names: Yihui
Expand Down Expand Up @@ -337,7 +337,7 @@ test <- cff_create("rmarkdown")
email: jeff@rstudio.com
year: '2022'
url: https://CRAN.R-project.org/package=htmltools
version: '>= 0.3.5'
version: '>= 0.5.1'
- type: software
title: jquerylib
abstract: 'jquerylib: Obtain ''jQuery'' as an HTML Dependency Object'
Expand Down
4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"codeRepository": "https://github.com/ropensci/cffr",
"issueTracker": "https://github.com/ropensci/cffr/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.2.3.9000",
"version": "0.3.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -187,7 +187,7 @@
},
"isPartOf": "https://ropensci.org",
"keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "r", "r-package", "citation-file-format", "rstats", "ropensci", "cran"],
"fileSize": "855.073KB",
"fileSize": "854.199KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down
3 changes: 2 additions & 1 deletion vignettes/crosswalk.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,8 @@ pkgnokeywords
# Adding Keywords
desc::desc_set("X-schema.org-keywords", "keyword1, keyword2, keyword3",
file = tmp2)
file = tmp2
)
cat(cff_create(tmp2)$keywords)
```
Expand Down

0 comments on commit 0d16a47

Please sign in to comment.