Skip to content

Commit

Permalink
Update docs with pkgdev
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 16, 2024
1 parent 784c8dc commit 6d8ece2
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 20 deletions.
3 changes: 3 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,9 @@ references:
email: [email protected]
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
identifiers:
- type: url
value: https://arxiv.org/abs/1403.2805
version: '>= 1.7.2'
- type: software
title: jsonvalidate
Expand Down
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,9 @@ 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
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
Expand Down Expand Up @@ -750,6 +753,18 @@ test <- cff_create("rmarkdown")
given-names: Davis
email: [email protected]
year: '2024'
- type: software
title: cleanrmd
abstract: 'cleanrmd: Clean Class-Less ''R Markdown'' HTML Documents'
notes: Suggests
url: https://pkg.garrickadenbuie.com/cleanrmd/
repository: https://CRAN.R-project.org/package=cleanrmd
authors:
- family-names: Aden-Buie
given-names: Garrick
email: [email protected]
orcid: https://orcid.org/0000-0002-7111-0077
year: '2024'
- type: software
title: withr
abstract: 'withr: Run Code ''With'' Temporarily Modified Global State'
Expand Down Expand Up @@ -888,9 +903,9 @@ for more info.

<div id="ref-codemeta" class="csl-entry">

Boettiger, Carl, and Maëlle Salmon. 2021a.
*<span class="nocase">codemeta</span>: A Smaller
<span class="nocase">codemetar</span> Package*.
Boettiger, Carl, and Maëlle Salmon. 2021a. *<span
class="nocase">codemeta</span>: A Smaller <span
class="nocase">codemetar</span> Package*.
<https://CRAN.R-project.org/package=codemeta>.

</div>
Expand All @@ -911,8 +926,8 @@ Among Citation Formats*.

<div id="ref-citation22" class="csl-entry">

Dietrich, Jan Philipp, and Waldir Leoncio. 2022.
*<span class="nocase">citation</span>: Software Citation Tools*.
Dietrich, Jan Philipp, and Waldir Leoncio. 2022. *<span
class="nocase">citation</span>: Software Citation Tools*.

</div>

Expand Down
6 changes: 3 additions & 3 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.3.2 (2023-10-31 ucrt)",
"runtimePlatform": "R version 4.3.2 (2023-10-31)",
"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": "1048.177KB",
"fileSize": "1030.282KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down Expand Up @@ -286,7 +286,7 @@
"sameAs": "https://doi.org/10.5281/zenodo.5171937"
}
],
"releaseNotes": "https://github.com/ropensci/cffr/blob/main/NEWS.md",
"releaseNotes": "https://github.com/ropensci/cffr/blob/master/NEWS.md",
"readme": "https://github.com/ropensci/cffr/blob/main/README.md",
"contIntegration": ["https://github.com/ropensci/cffr/actions/workflows/check-full.yaml", "https://app.codecov.io/gh/ropensci/cffr", "https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml"],
"developmentStatus": ["https://www.repostatus.org/#active", "https://lifecycle.r-lib.org/articles/stages.html#experimental"],
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.3.2 (2023-10-31 ucrt)",
"runtimePlatform": "R version 4.3.2 (2023-10-31)",
"version": "0.5.0.9000"
}
11 changes: 5 additions & 6 deletions man/cff-class.Rd

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

9 changes: 4 additions & 5 deletions man/chunks/cffclass.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,10 @@ c(minimal_cff, new_keys)
Special case for those CFF keys that are person-like.

```{r}
path <- system.file("examples/CITATION_complete.cff", package = "cffr")
the_cff <- cff_read(path)
path <- system.file("examples/CITATION_complete.cff", package = "cffr")
the_cff <- cff_read(path)
the_cff$authors
the_cff$authors
as.person(the_cff$authors)
as.person(the_cff$authors)
```

0 comments on commit 6d8ece2

Please sign in to comment.