Skip to content

Commit

Permalink
docs: add codemeta & cff
Browse files Browse the repository at this point in the history
  • Loading branch information
rCarto committed Oct 17, 2023
1 parent 7e7708f commit 7442cd6
Show file tree
Hide file tree
Showing 3 changed files with 168 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
^README\.Rmd$
^\.github$
^codecov\.yml$
^CITATION\.cff$
^codemeta\.json$
85 changes: 85 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------

cff-version: 1.2.0
message: 'To cite package "maplegend" in publications use:'
type: software
license: GPL-3.0-only
title: 'maplegend: Legends for Maps'
version: 0.1.0
abstract: Create legends for maps and other graphics. Thematic maps need to be accompanied
by legible legends to be fully comprehensible. This package offers a wide range
of legends useful for cartography, some of which may also be useful for other types
of graphics.
authors:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
repository-code: https://github.com/riatelab/maplegend/issues/
url: https://github.com/riatelab/maplegend/
contact:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
references:
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
url: https://www.R-project.org/
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2023'
institution:
name: R Foundation for Statistical Computing
version: '>= 3.6.0'
- type: software
title: graphics
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2023'
institution:
name: R Foundation for Statistical Computing
- type: software
title: grDevices
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2023'
institution:
name: R Foundation for Statistical Computing
- type: software
title: tinytest
abstract: 'tinytest: Lightweight and Feature Complete Unit Testing Framework'
notes: Suggests
url: https://github.com/markvanderloo/tinytest
repository: https://CRAN.R-project.org/package=tinytest
authors:
- family-names: van der Loo
given-names: Mark
email: mark.vanderloo@gmail.com
orcid: https://orcid.org/0000-0002-9807-4686
year: '2023'
- type: software
title: covr
abstract: 'covr: Test Coverage for Packages'
notes: Suggests
url: https://covr.r-lib.org
repository: https://CRAN.R-project.org/package=covr
authors:
- family-names: Hester
given-names: Jim
email: james.f.hester@gmail.com
year: '2023'
81 changes: 81 additions & 0 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "maplegend",
"description": "Create legends for maps and other graphics. Thematic maps need to be accompanied by legible legends to be fully comprehensible. This package offers a wide range of legends useful for cartography, some of which may also be useful for other types of graphics. ",
"name": "maplegend: Legends for Maps",
"codeRepository": "https://github.com/riatelab/maplegend/",
"issueTracker": "https://github.com/riatelab/maplegend/issues/",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.1.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.3.1 (2023-06-16)",
"author": [
{
"@type": "Person",
"givenName": "Timothée",
"familyName": "Giraud",
"email": "timothee.giraud@cnrs.fr",
"@id": "https://orcid.org/0000-0002-1932-3323"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Timothée",
"familyName": "Giraud",
"email": "timothee.giraud@cnrs.fr",
"@id": "https://orcid.org/0000-0002-1932-3323"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "tinytest",
"name": "tinytest",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=tinytest"
},
{
"@type": "SoftwareApplication",
"identifier": "covr",
"name": "covr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=covr"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "R",
"name": "R",
"version": ">= 3.6.0"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "graphics",
"name": "graphics"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "grDevices",
"name": "grDevices"
},
"SystemRequirements": null
},
"fileSize": "128.733KB"
}

0 comments on commit 7442cd6

Please sign in to comment.