Skip to content

Commit

Permalink
Prepare for CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Apr 9, 2024
1 parent 8eaa789 commit 4f9dc40
Show file tree
Hide file tree
Showing 13 changed files with 40 additions and 854 deletions.
5 changes: 1 addition & 4 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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: 1.0.0.9000
version: 1.0.1
doi: 10.21105/joss.03900
abstract: The Citation File Format version 1.2.0 <https://doi.org/10.5281/zenodo.5171937>
is a human and machine readable file format which provides citation metadata for
Expand Down Expand Up @@ -138,9 +138,6 @@ references:
email: jeroen@berkeley.edu
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
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: 1.0.0.9000
Version: 1.0.1
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
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# cffr (development version)
# cffr 1.0.1

- Update `cff_write()` to add a new `encoding` argument to make it work with
different encodings, see `iconv()`.
- Fix NOTEs due to empty lines in docs.
- Fix **NOTEs** due to empty lines in docs.

# cffr 1.0.0

Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ install.packages("cffr")
You can install the developing version of **cffr** with:

```{r, eval=FALSE}
devtools::install_github("ropensci/cffr")
remotes::install_github("ropensci/cffr")
```

Alternatively, you can install **cffr** using the
Expand Down
76 changes: 4 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,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-04-09 there are at least 351 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 @@ -384,9 +385,6 @@ test <- cff_create("rmarkdown")
email: jeroen@berkeley.edu
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 @@ -551,26 +549,6 @@ test <- cff_create("rmarkdown")
- family-names: Chirico.
given-names: Michael
year: '2024'
- 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
website: http://dygraphs.com/
- 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: '2024'
- type: software
title: fs
abstract: 'fs: Cross-Platform File System Operations Based on ''libuv'''
Expand All @@ -587,26 +565,6 @@ test <- cff_create("rmarkdown")
given-names: Gábor
email: csardi.gabor@gmail.com
year: '2024'
- type: software
title: rsconnect
abstract: 'rsconnect: Deploy Docs, Apps, and APIs to ''Posit Connect'', ''shinyapps.io'',
and ''RPubs'''
notes: Suggests
url: https://rstudio.github.io/rsconnect/
repository: https://CRAN.R-project.org/package=rsconnect
authors:
- family-names: Atkins
given-names: Aron
email: aron@posit.co
- family-names: Allen
given-names: Toph
- family-names: Wickham
given-names: Hadley
- family-names: McPherson
given-names: Jonathan
- family-names: Allaire
given-names: JJ
year: '2024'
- type: software
title: downlit
abstract: 'downlit: Syntax Highlighting and Automatic Linking'
Expand All @@ -619,19 +577,6 @@ test <- cff_create("rmarkdown")
email: hadley@posit.co
year: '2024'
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: jeroen@berkeley.edu
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
version: '>= 1.4.0'
- type: software
title: sass
abstract: 'sass: Syntactically Awesome Style Sheets (''Sass'')'
Expand Down Expand Up @@ -742,18 +687,6 @@ test <- cff_create("rmarkdown")
given-names: Davis
email: davis@posit.co
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: garrick@adenbuie.com
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,8 +821,7 @@ for more info.

## References

<div id="refs" class="references csl-bib-body hanging-indent"
entry-spacing="0">
<div id="refs" class="references csl-bib-body hanging-indent">

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

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": "1.0.0.9000",
"version": "1.0.1",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
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": "1600.405KB",
"fileSize": "1598.15KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down

0 comments on commit 4f9dc40

Please sign in to comment.