Skip to content

Commit

Permalink
Refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Jun 16, 2023
1 parent c193760 commit 182ad69
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 96 deletions.
8 changes: 6 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -300,14 +300,18 @@ references:
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Bryan
given-names: Jennifer
email: jenny@rstudio.com
email: jenny@posit.co
orcid: https://orcid.org/0000-0002-6983-2759
- family-names: Barrett
given-names: Malcolm
email: [email protected]
orcid: https://orcid.org/0000-0003-0299-5825
- family-names: Teucher
given-names: Andy
email: [email protected]
orcid: https://orcid.org/0000-0002-7840-692X
year: '2023'
41 changes: 24 additions & 17 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ knitr::opts_chunk$set(
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/cffr?color=blue)](https://cran.r-project.org/package=cffr)
[![R-CMD-check](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml)
[![codecov](https://codecov.io/gh/ropensci/cffr/branch/main/graph/badge.svg?token=YRO3XL8RWK)](https://app.codecov.io/gh/ropensci/cffr)
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/)
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/cffr)
[![CITATION-cff](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03900/status.svg)](https://doi.org/10.21105/joss.03900)
[![Project Status: Active - The project has reached a stable, usable state and
Expand Down Expand Up @@ -141,14 +141,10 @@ Alternatively, you can install **cffr** using the
[r-universe](https://ropensci.r-universe.dev/cffr):

```{r, eval=FALSE}
# Enable this universe
options(repos = c(
ropensci = "https://ropensci.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))
# Install some packages
install.packages("cffr")
# Install cffr in R:
install.packages("cffr",
repos = c("https://ropensci.r-universe.dev", "https://cloud.r-project.org")
)
```

### Example
Expand Down Expand Up @@ -263,14 +259,25 @@ Check the following articles to learn more about **cffr**:

## Citation

```{r echo=FALSE, results='asis'}
print(citation("cffr")[1], bibtex = FALSE)
```

A BibTeX entry for LaTeX users is

```{r echo=FALSE, comment=''}
toBibtex(citation("cffr")[1])
Hernangómez, D., (2021). cffr: Generate Citation File Format Metadata for R
Packages. Journal of Open Source Software, 6(67), 3900,
<https://doi.org/10.21105/joss.03900>

A BibTeX entry for LaTeX users is:

``` bibtex
@article{hernangomez2021,
title = {{cffr}: Generate Citation File Format Metadata for {R} Packages},
author = {Diego Hernangómez},
year = 2021,
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
volume = 6,
number = 67,
pages = 3900,
doi = {10.21105/joss.03900},
url = {https://doi.org/10.21105/joss.03900}
}
```

You can also use the [citation provided by
Expand Down
104 changes: 29 additions & 75 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/cffr?color=blue)](https://cran.r-project.org/package=cffr)
[![R-CMD-check](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml)
[![codecov](https://codecov.io/gh/ropensci/cffr/branch/main/graph/badge.svg?token=YRO3XL8RWK)](https://app.codecov.io/gh/ropensci/cffr)
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/)
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/cffr)
[![CITATION-cff](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03900/status.svg)](https://doi.org/10.21105/joss.03900)
[![Project Status: Active - The project has reached a stable, usable
Expand Down Expand Up @@ -72,7 +72,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 2023-05-24 there are at least 160 repos on GitHub using **cffr**.
As per 2023-06-16 there are at least 203 repos on GitHub using **cffr**.
[Check them out
here](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code).

Expand All @@ -94,14 +94,10 @@ Alternatively, you can install **cffr** using the
[r-universe](https://ropensci.r-universe.dev/cffr):

``` r
# Enable this universe
options(repos = c(
ropensci = "https://ropensci.r-universe.dev",
CRAN = "https://cloud.r-project.org"
))

# Install some packages
install.packages("cffr")
# Install cffr in R:
install.packages("cffr",
repos = c("https://ropensci.r-universe.dev", "https://cloud.r-project.org")
)
```

### Example
Expand Down Expand Up @@ -147,7 +143,7 @@ test <- cff_create("rmarkdown")
type: software
license: GPL-3.0-only
title: 'rmarkdown: Dynamic Documents for R'
version: '2.21'
version: '2.22'
abstract: Convert R Markdown documents into a variety of formats.
authors:
- family-names: Allaire
Expand Down Expand Up @@ -225,12 +221,12 @@ test <- cff_create("rmarkdown")
email: [email protected]
orcid: https://orcid.org/0000-0003-3925-190X
year: '2023'
notes: R package version 2.21
notes: R package version 2.22
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: '2023-03-26'
date-released: '2023-06-01'
contact:
- family-names: Xie
given-names: Yihui
Expand Down Expand Up @@ -300,6 +296,10 @@ test <- cff_create("rmarkdown")
- family-names: Cheng
given-names: Joe
email: [email protected]
- family-names: Aden-Buie
given-names: Garrick
email: [email protected]
orcid: https://orcid.org/0000-0002-7111-0077
year: '2023'
version: '>= 0.2.5.1'
- type: software
Expand Down Expand Up @@ -561,25 +561,6 @@ test <- cff_create("rmarkdown")
- family-names: Chang.
given-names: and Winston
year: '2023'
- type: software
title: dygraphs
abstract: 'dygraphs: Interface to ''Dygraphs'' Interactive Time Series Charting
Library'
notes: Suggests
url: https://github.com/rstudio/dygraphs
repository: https://CRAN.R-project.org/package=dygraphs
authors:
- family-names: Vanderkam
given-names: Dan
- family-names: Allaire
given-names: JJ
- family-names: Owen
given-names: Jonathan
- family-names: Gromer
given-names: Daniel
- family-names: Thieurmel
given-names: Benoit
year: '2023'
- type: software
title: fs
abstract: 'fs: Cross-Platform File System Operations Based on ''libuv'''
Expand All @@ -596,22 +577,6 @@ test <- cff_create("rmarkdown")
given-names: Gábor
email: [email protected]
year: '2023'
- type: software
title: rsconnect
abstract: 'rsconnect: Deployment Interface for R Markdown Documents and Shiny Applications'
notes: Suggests
url: https://github.com/rstudio/rsconnect
repository: https://CRAN.R-project.org/package=rsconnect
authors:
- family-names: Atkins
given-names: Aron
email: [email protected]
- family-names: McPherson
given-names: Jonathan
email: [email protected]
- family-names: Allaire
given-names: JJ
year: '2023'
- type: software
title: downlit
abstract: 'downlit: Syntax Highlighting and Automatic Linking'
Expand All @@ -624,19 +589,6 @@ test <- cff_create("rmarkdown")
email: [email protected]
year: '2023'
version: '>= 0.4.0'
- type: software
title: katex
abstract: 'katex: Rendering Math to HTML, ''MathML'', or R-Documentation Format'
notes: Suggests
url: https://docs.ropensci.org/katex/
repository: https://CRAN.R-project.org/package=katex
authors:
- family-names: Ooms
given-names: Jeroen
email: [email protected]
orcid: https://orcid.org/0000-0002-4035-0289
year: '2023'
version: '>= 1.4.0'
- type: software
title: sass
abstract: 'sass: Syntactically Awesome Style Sheets (''Sass'')'
Expand Down Expand Up @@ -856,20 +808,22 @@ Hernangómez, D., (2021). cffr: Generate Citation File Format Metadata
for R Packages. Journal of Open Source Software, 6(67), 3900,
<https://doi.org/10.21105/joss.03900>

A BibTeX entry for LaTeX users is

@Article{hernangomez2021,
doi = {10.21105/joss.03900},
url = {https://doi.org/10.21105/joss.03900},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {67},
pages = {3900},
author = {Diego Hernangómez},
title = {{cffr}: Generate Citation File Format Metadata for {R} Packages},
journal = {Journal of Open Source Software},
}
A BibTeX entry for LaTeX users is:

``` bibtex
@article{hernangomez2021,
title = {{cffr}: Generate Citation File Format Metadata for {R} Packages},
author = {Diego Hernangómez},
year = 2021,
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
volume = 6,
number = 67,
pages = 3900,
doi = {10.21105/joss.03900},
url = {https://doi.org/10.21105/joss.03900}
}
```

You can also use the [citation provided by
GitHub](https://github.com/ropensci/cffr), that is generated from the
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
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": "885.058KB",
"fileSize": "883.407KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down
Binary file modified data/cran_to_spdx.rda
Binary file not shown.
1 change: 0 additions & 1 deletion inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ bibentry(
author = person("Diego", "Hernangómez"),
title = "{cffr}: Generate Citation File Format Metadata for {R} Packages",
journal = "Journal of Open Source Software",
textVersion = "Hernangómez, D., (2021). cffr: Generate Citation File Format Metadata for R Packages. Journal of Open Source Software, 6(67), 3900, https://doi.org/10.21105/joss.03900"
)

bibentry(
Expand Down

0 comments on commit 182ad69

Please sign in to comment.