Skip to content

Commit

Permalink
Minimal doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Aug 28, 2024
1 parent 845c869 commit 54d4f08
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 18 deletions.
3 changes: 0 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,6 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
identifiers:
- type: url
value: https://arxiv.org/abs/1403.2805
doi: 10.32614/CRAN.package.jsonlite
version: '>= 1.7.2'
- type: software
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ file and the `CITATION` file (if present) of your package. Note that
**cffr** works best if your package pass
`R CMD check/devtools::check()`.

See [some projects already using
**cffr**](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code).
As per 2024-08-28 there are at least 288 repos on GitHub using **cffr**.
[Check them out
here](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code).

### Installation

Expand Down Expand Up @@ -393,9 +394,6 @@ test <- cff_create("rmarkdown")
email: [email protected]
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
identifiers:
- type: url
value: https://arxiv.org/abs/1403.2805
doi: 10.32614/CRAN.package.jsonlite
- type: software
title: knitr
Expand Down
4 changes: 2 additions & 2 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.4.1 (2024-06-14)",
"runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
Expand Down Expand Up @@ -200,7 +200,7 @@
},
"isPartOf": "https://ropensci.org",
"keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "r", "r-package", "citation-file-format", "rstats", "ropensci", "cran"],
"fileSize": "1604.159KB",
"fileSize": "1624.479KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down
Binary file modified data/cran_to_spdx.rda
Binary file not shown.
2 changes: 1 addition & 1 deletion inst/schemaorg.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"runtimePlatform": "R version 4.4.1 (2024-06-14)",
"runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)",
"version": "1.1.1"
}
4 changes: 2 additions & 2 deletions man/cff_class.Rd

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

10 changes: 5 additions & 5 deletions vignettes/crosswalk.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ This key is extracted from the `DESCRIPTION` file following this logic:
- If not present, from `"Date/Publication"`. This is present on packages built
on **CRAN** and **Bioconductor**. or,
- If not present, from `"Packaged"`, that is present on packages built by the
[r-universe](https://r-universe.dev/searchsearch/).
[r-universe](https://r-universe.dev/search).

<details>

Expand Down Expand Up @@ -512,10 +512,10 @@ citation("rmarkdown")[-1]

This key is extracted from the `"Repository"` field of the `DESCRIPTION` file.
Usually, this field is auto-populated when a package is hosted on a repo (like
**CRAN** or the [r-universe](https://r-universe.dev/search)). For packages without
this field on the `DESCRIPTION` (that is the typical case for an in-development
package), **cffr** would try to search the package on any of the default
repositories specified on `options("repos")`.
**CRAN** or the [r-universe](https://r-universe.dev/search)). For packages
without this field on the `DESCRIPTION` (that is the typical case for an
in-development package), **cffr** would try to search the package on any of the
default repositories specified on `options("repos")`.

In the case of [Bioconductor](https://bioconductor.org/) packages, those are
identified if a
Expand Down

0 comments on commit 54d4f08

Please sign in to comment.