tests/testthat/_snaps/cff_create.md

In cffr: Generate Citation File Format ('cff') Metadata for R Packages

Test indev

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "basicdesc" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'basicdesc: A Basic Description'
  version: 0.1.6
  abstract: A very basic description. Should parse without problems.
  authors:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]
  repository-code: https://github.com/basic/package
  url: https://basic.github.io/package
  contact:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]

No auto generate preferred citations

Code
  cff_create(rgeos, gh_keywords = FALSE, keys = list(references = NULL))
Output
  cff-version: 1.2.0
  message: 'To cite package "rgeos" in publications use:'
  type: software
  license: GPL-2.0-or-later
  title: 'rgeos: Interface to Geometry Engine - Open Source (''GEOS'')'
  version: 0.5-7
  identifiers:
  - type: url
    value: http://rgeos.r-forge.r-project.org/index.html
  abstract: 'Interface to Geometry Engine - Open Source (''GEOS'') using the C ''API''
    for topology operations on geometries. Please note that ''rgeos'' will be retired
    by the end of 2023, plan transition to sf functions using ''GEOS'' at your earliest
    convenience. The ''GEOS'' library is external to the package, and, when installing
    the package from source, must be correctly installed first. Windows and Mac Intel
    OS X binaries are provided on ''CRAN''. (''rgeos'' >= 0.5-1): Up to and including
    ''GEOS'' 3.7.1, topological operations succeeded with some invalid geometries for
    which the same operations fail from and including ''GEOS'' 3.7.2. The ''checkValidity=''
    argument defaults and structure have been changed, from default FALSE to integer
    default ''0L'' for ''GEOS'' < 3.7.2 (no check), ''1L'' ''GEOS'' >= 3.7.2 (check
    and warn). A value of ''2L'' is also provided that may be used, assigned globally
    using ''set_RGEOS_CheckValidity(2L)'', or locally using the ''checkValidity=2L''
    argument, to attempt zero-width buffer repair if invalid geometries are found. The
    previous default (FALSE, now ''0L'') is fastest and used for ''GEOS'' < 3.7.2, but
    will not warn users of possible problems before the failure of topological operations
    that previously succeeded. From ''GEOS'' 3.8.0, repair of geometries may also be
    attempted using ''gMakeValid()'', which may, however, return a collection of geometries
    of different types.'
  authors:
  - family-names: Bivand
    given-names: Roger
    email: [e-mail]
    orcid: https://orcid.org/0000-0003-2392-6140
  - family-names: Rundel
    given-names: Colin
  repository: https://CRAN.R-project.org/package=rgeos
  repository-code: https://r-forge.r-project.org/projects/rgeos/
  url: https://trac.osgeo.org/geos/
  date-released: '2020-09-07'
  contact:
  - family-names: Bivand
    given-names: Roger
    email: [e-mail]
    orcid: https://orcid.org/0000-0003-2392-6140

Code
  cff_create(basicdate, gh_keywords = FALSE, keys = list(references = NULL))
Output
  cff-version: 1.2.0
  message: 'To cite package "basicdescdate" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'basicdescdate: A Basic Description with Date'
  version: 0.1.6
  abstract: A very basic description. Should parse without problems. I have a Date
  authors:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]
  repository-code: https://github.com/basic/package
  url: https://basic.github.io/package
  date-released: '1999-01-01'
  contact:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]

Fuzzy match on cff_create

Code
  print_snapshot("Fuzzy match on cff_create", modobject)
Output


  ## Fuzzy match on cff_create

  cff-version: 1.2.0
  message: If you use this software, please cite it using these metadata.
  title: Modifying a 'cff' object
  version: 0.0.1
  authors:
  - family-names: Doe
    given-names: John
  repository: https://github.com/user/repo
  url: https://ropensci.org/

  ---

Coerce date

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "rgeos" in publications use:'
  type: software
  license: GPL-2.0-or-later
  title: 'rgeos: Interface to Geometry Engine - Open Source (''GEOS'')'
  version: 0.5-7
  identifiers:
  - type: url
    value: http://rgeos.r-forge.r-project.org/index.html
  abstract: 'Interface to Geometry Engine - Open Source (''GEOS'') using the C ''API''
    for topology operations on geometries. Please note that ''rgeos'' will be retired
    by the end of 2023, plan transition to sf functions using ''GEOS'' at your earliest
    convenience. The ''GEOS'' library is external to the package, and, when installing
    the package from source, must be correctly installed first. Windows and Mac Intel
    OS X binaries are provided on ''CRAN''. (''rgeos'' >= 0.5-1): Up to and including
    ''GEOS'' 3.7.1, topological operations succeeded with some invalid geometries for
    which the same operations fail from and including ''GEOS'' 3.7.2. The ''checkValidity=''
    argument defaults and structure have been changed, from default FALSE to integer
    default ''0L'' for ''GEOS'' < 3.7.2 (no check), ''1L'' ''GEOS'' >= 3.7.2 (check
    and warn). A value of ''2L'' is also provided that may be used, assigned globally
    using ''set_RGEOS_CheckValidity(2L)'', or locally using the ''checkValidity=2L''
    argument, to attempt zero-width buffer repair if invalid geometries are found. The
    previous default (FALSE, now ''0L'') is fastest and used for ''GEOS'' < 3.7.2, but
    will not warn users of possible problems before the failure of topological operations
    that previously succeeded. From ''GEOS'' 3.8.0, repair of geometries may also be
    attempted using ''gMakeValid()'', which may, however, return a collection of geometries
    of different types.'
  authors:
  - family-names: Bivand
    given-names: Roger
    email: [e-mail]
    orcid: https://orcid.org/0000-0003-2392-6140
  - family-names: Rundel
    given-names: Colin
  repository: https://CRAN.R-project.org/package=rgeos
  repository-code: https://r-forge.r-project.org/projects/rgeos/
  url: https://trac.osgeo.org/geos/
  date-released: '2020-09-07'
  contact:
  - family-names: Bivand
    given-names: Roger
    email: [e-mail]
    orcid: https://orcid.org/0000-0003-2392-6140

Coerce date in another format

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "basicdescdate" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'basicdescdate: A Basic Description with Date'
  version: 0.1.6
  abstract: A very basic description. Should parse without problems. I have a Date
  authors:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]
  repository-code: https://github.com/basic/package
  url: https://basic.github.io/package
  date-released: '1999-01-01'
  contact:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]

Parsing many urls

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "manyurls" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'manyurls: A lot of urls'
  version: 0.1.6
  identifiers:
  - type: url
    value: https://r-forge.r-project.org/projects/test/
  - type: url
    value: http://google.ru
  - type: url
    value: https://gitlab.com/r-packages/behaviorchange
  abstract: This package has many urls. Specifically, 1 Bug Reports and 6 URLs. Expected
    is to have 1 repository-code, 1 url and 3 URLs, since there is 1 duplicate and 1
    invalid url.
  authors:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]
  repository-code: https://github.com/test/package
  url: https://test.github.io/package/
  contact:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]

Parsing Gitlab

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "codemetar" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'codemetar: Generate ''CodeMeta'' Metadata for R Packages'
  version: 0.1.6
  doi: 10.32614/CRAN.package.codemetar
  abstract: The 'Codemeta' Project defines a 'JSON-LD' format for describing software
    metadata, as detailed at <https://codemeta.github.io>. This package provides utilities
    to generate, parse, and modify 'codemeta.json' files automatically for R packages,
    as well as tools and examples for working with 'codemeta.json' 'JSON-LD' more generally.
  authors:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
    orcid: https://orcid.org/0000-0002-1642-628X
  - family-names: Salmon
    given-names: Maëlle
    orcid: https://orcid.org/0000-0002-2815-0399
  repository: https://CRAN.R-project.org/package=codemetar
  repository-code: https://gitlab.com/ninijay/methoden
  url: https://ropensci.github.io/codemetar
  contact:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
    orcid: https://orcid.org/0000-0002-1642-628X
  keywords:
  - metadata
  - codemeta
  - ropensci
  - citation
  - credit
  - linked-data

Parsing many persons

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "manypersons" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'manypersons: A lot of persons'
  version: 0.1.6
  abstract: Overkill desc with many persons. Try this
  authors:
  - family-names: Hernangómez
    given-names: Diego
    email: [e-mail]
    orcid: https://orcid.org/0000-0001-8457-4658
  - family-names: Doe
    given-names: Joe
    affiliation: This One
    country: ES
  - family-names: Doe
    given-names: Pepe
    email: [e-mail]
  - name: I am an entity
    date-end: '2020-01-01'
  repository-code: https://github.com/many/persons
  url: https://many.github.io/persons
  contact:
  - family-names: Hernangómez
    given-names: Diego
    email: [e-mail]
    orcid: https://orcid.org/0000-0001-8457-4658
  - name: I am an entity
    date-end: '2020-01-01'
  keywords:
  - metadata
  - cffr
  - ropensci
  - citation
  - credit
  - linked-data
  - one
  - two

Parsing wrong urls

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "wrongurls" in publications use:'
  type: software
  license: MIT
  title: 'wrongurls: Generate CodeMeta Metadata for R Packages'
  version: 0.1.0
  identifiers:
  - type: url
    value: https://httpbin.org/status/429
  - type: url
    value: https://www.github.es/ropensci/codemeta
  abstract: Codemeta defines a 'JSON-LD' format for describing software metadata. This
    package provides utilities to generate, parse, and modify codemeta.jsonld files
    automatically for R packages.
  authors:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
  url: https://httpbin.org/status/404
  contact:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
  keywords:
  - metadata
  - codemeta
  - ropensci
  - citation
  - credit
  - linked-data

Parsing two maintainers

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "codemetar" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'codemetar: Generate ''CodeMeta'' Metadata for R Packages'
  version: 0.1.6
  doi: 10.32614/CRAN.package.codemetar
  abstract: The 'Codemeta' Project defines a 'JSON-LD' format for describing software
    metadata, as detailed at <https://codemeta.github.io>. This package provides utilities
    to generate, parse, and modify 'codemeta.json' files automatically for R packages,
    as well as tools and examples for working with 'codemeta.json' 'JSON-LD' more generally.
  authors:
  - family-names: Ok
    given-names: John
    email: [e-mail]
  - family-names: Doe
    given-names: Jane
    email: [e-mail]
  - family-names: Doo
    given-names: Jane
  repository: https://CRAN.R-project.org/package=codemetar
  repository-code: https://github.com/ropensci/codemetar
  url: https://ropensci.github.io/codemetar
  contact:
  - family-names: Ok
    given-names: John
    email: [e-mail]
  - family-names: Doe
    given-names: Jane
    email: [e-mail]

Parsing r-universe

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "codemetar" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'codemetar: Generate ''CodeMeta'' Metadata for R Packages'
  version: 0.3.5
  doi: 10.32614/CRAN.package.codemetar
  abstract: The 'Codemeta' Project defines a 'JSON-LD' format for describing software
    metadata, as detailed at <https://codemeta.github.io>. This package provides utilities
    to generate, parse, and modify 'codemeta.json' files automatically for R packages,
    as well as tools and examples for working with 'codemeta.json' 'JSON-LD' more generally.
  authors:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
    orcid: https://orcid.org/0000-0002-1642-628X
  - family-names: Salmon
    given-names: Maëlle
    orcid: https://orcid.org/0000-0002-2815-0399
  repository: https://ropensci.r-universe.dev
  repository-code: https://github.com/ropensci/codemetar
  commit: bdd9a29d7eabcc43c3195fe461f884932eba763c
  url: https://docs.ropensci.org/codemetar/
  date-released: '2024-02-09'
  contact:
  - family-names: Boettiger
    given-names: Carl
    email: [e-mail]
    orcid: https://orcid.org/0000-0002-1642-628X
  keywords:
  - metadata
  - codemeta
  - ropensci
  - citation
  - credit
  - linked-data

Parsing Bioconductor

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "GenomicRanges" in publications use:'
  type: software
  license: Artistic-2.0
  title: 'GenomicRanges: Representation and manipulation of genomic intervals'
  version: 1.51.4
  abstract: The ability to efficiently represent and manipulate genomic annotations
    and alignments is playing a central role when it comes to analyzing high-throughput
    sequencing data (a.k.a. NGS data). The GenomicRanges package defines general purpose
    containers for storing and manipulating genomic intervals and variables defined
    along a genome. More specialized containers for representing and manipulating short
    alignments against a reference genome, or a matrix-like summarization of an experiment,
    are defined in the GenomicAlignments and SummarizedExperiment packages, respectively.
    Both packages build on top of the GenomicRanges infrastructure.
  authors:
  - family-names: Aboyoun
    given-names: Patrick
  - family-names: Pagès
    given-names: Hervé
    email: [e-mail]
  - family-names: Lawrence
    given-names: Michael
  repository: https://bioconductor.org/
  repository-code: https://github.com/Bioconductor/GenomicRanges
  url: https://bioconductor.org/packages/GenomicRanges
  date-released: '2022-12-15'
  contact:
  - family-names: Pagès
    given-names: Hervé
    email: [e-mail]

Parsing Posit Package Manager

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "resmush" in publications use:'
  type: software
  license: MIT
  title: 'resmush: Optimize and Compress Image Files with ''reSmush.it'''
  version: 0.1.0
  doi: 10.32614/CRAN.package.resmush
  abstract: Compress local and online images using the 'reSmush.it' API service <https://resmush.it/>.
  authors:
  - family-names: Hernangómez
    given-names: Diego
    email: [e-mail]
    orcid: https://orcid.org/0000-0001-8457-4658
  repository: https://CRAN.R-project.org/package=resmush
  repository-code: https://github.com/dieghernan/resmush
  url: https://dieghernan.github.io/resmush/
  date-released: '2024-02-02'
  contact:
  - family-names: Hernangómez
    given-names: Diego
    email: [e-mail]
    orcid: https://orcid.org/0000-0001-8457-4658
  keywords:
  - r
  - compress-images
  - optimize-images
  - resmushit
  - api

Search package on CRAN

Code
  a_cff
Output
  cff-version: 1.2.0
  message: 'To cite package "ggplot2" in publications use:'
  type: software
  license: GPL-3.0-only
  title: 'ggplot2: A Basic Description'
  version: 0.1.6
  doi: 10.32614/CRAN.package.ggplot2
  abstract: A very basic description. Should parse without problems.
  authors:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]
  repository: https://CRAN.R-project.org/package=ggplot2
  repository-code: https://github.com/basic/package
  url: https://basic.github.io/package
  contact:
  - family-names: Basic
    given-names: Marc
    email: [e-mail]

cffr documentation built on Sept. 11, 2024, 8:41 p.m.