docs: add codemeta, cff and badge

riatelab · Jul 4, 2022 · c8badcf · c8badcf
1 parent e2039d7
commit c8badcf
Show file tree

Hide file tree

Showing 4 changed files with 279 additions and 1 deletion.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,5 @@
 ^data-raw$
 ^img$
 ^\.github$
+^codemeta\.json$
+^CITATION\.cff$
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,141 @@
+# -----------------------------------------------------------
+# CITATION file created with {cffr} R package, v0.2.2
+# See also: https://docs.ropensci.org/cffr/
+# -----------------------------------------------------------
+
+cff-version: 1.2.0
+message: 'To cite package "tanaka" in publications use:'
+type: software
+license: GPL-3.0-only
+title: 'tanaka: Design Shaded Contour Lines (or Tanaka) Maps'
+version: 0.3.0
+abstract: The Tanaka method enhances the representation of topography on a map using
+  shaded contour lines. In this simplified implementation of the method, north-west
+  white contours represent illuminated topography and south-east black contours represent
+  shaded topography. See Tanaka (1950) <doi:10.2307/211219>.
+authors:
+- family-names: Giraud
+  given-names: Timothée
+  email: [email protected]
+  orcid: https://orcid.org/0000-0002-1932-3323
+preferred-citation:
+  type: manual
+  title: 'tanaka: Design Shaded Contour Lines (or Tanaka) Maps'
+  authors:
+  - family-names: Giraud
+    given-names: Timothée
+    email: [email protected]
+    orcid: https://orcid.org/0000-0002-1932-3323
+  version: 0.3.0
+  abstract: The Tanaka method enhances the representation of topography on a map using
+    shaded contour lines. In this simplified implementation of the method, north-west
+    white contours represent illuminated topography and south-east black contours
+    represent shaded topography. See Tanaka (1950) <doi:10.2307/211219>.
+  repository: https://CRAN.R-project.org/package=tanaka
+  repository-code: https://github.com/riatelab/tanaka/issues/
+  url: https://github.com/riatelab/tanaka/
+  contact:
+  - family-names: Giraud
+    given-names: Timothée
+    email: [email protected]
+    orcid: https://orcid.org/0000-0002-1932-3323
+  license: GPL-3.0-only
+  year: '2022'
+repository: https://CRAN.R-project.org/package=tanaka
+repository-code: https://github.com/riatelab/tanaka/issues/
+url: https://github.com/riatelab/tanaka/
+contact:
+- family-names: Giraud
+  given-names: Timothée
+  email: [email protected]
+  orcid: https://orcid.org/0000-0002-1932-3323
+references:
+- type: software
+  title: terra
+  abstract: 'terra: Spatial Data Analysis'
+  notes: Imports
+  authors:
+  - family-names: Hijmans
+    given-names: Robert J.
+    email: [email protected]
+    orcid: https://orcid.org/0000-0001-5872-2872
+  year: '2022'
+  url: https://CRAN.R-project.org/package=terra
+- type: software
+  title: sf
+  abstract: 'sf: Simple Features for R'
+  notes: Imports
+  authors:
+  - family-names: Pebesma
+    given-names: Edzer
+    email: [email protected]
+    orcid: https://orcid.org/0000-0001-8049-7069
+  year: '2022'
+  url: https://CRAN.R-project.org/package=sf
+- type: software
+  title: mapiso
+  abstract: 'mapiso: Create Contour Polygons from Regular Grids'
+  notes: Imports
+  authors:
+  - family-names: Giraud
+    given-names: Timothée
+    email: [email protected]
+    orcid: https://orcid.org/0000-0002-1932-3323
+  year: '2022'
+  url: https://CRAN.R-project.org/package=mapiso
+- 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: '2022'
+  url: https://www.R-project.org/
+  institution:
+    name: R Foundation for Statistical Computing
+- 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: '2022'
+  url: https://www.R-project.org/
+  institution:
+    name: R Foundation for Statistical Computing
+- type: software
+  title: tinytest
+  abstract: 'tinytest: Lightweight and Feature Complete Unit Testing Framework'
+  notes: Suggests
+  authors:
+  - family-names: van der Loo
+    given-names: Mark
+    email: [email protected]
+    orcid: https://orcid.org/0000-0002-9807-4686
+  year: '2022'
+  url: https://CRAN.R-project.org/package=tinytest
+- type: software
+  title: covr
+  abstract: 'covr: Test Coverage for Packages'
+  notes: Suggests
+  authors:
+  - family-names: Hester
+    given-names: Jim
+    email: [email protected]
+  year: '2022'
+  url: https://CRAN.R-project.org/package=covr
+- type: software
+  title: lwgeom
+  abstract: 'lwgeom: Bindings to Selected ''liblwgeom'' Functions for Simple Features'
+  notes: Suggests
+  authors:
+  - family-names: Pebesma
+    given-names: Edzer
+    email: [email protected]
+    orcid: https://orcid.org/0000-0001-8049-7069
+  year: '2022'
+  url: https://CRAN.R-project.org/package=lwgeom
diff --git a/README.md b/README.md
@@ -6,7 +6,9 @@
 [![R-CMD-check](https://github.com/riatelab/tanaka/workflows/R-CMD-check/badge.svg)](https://github.com/riatelab/tanaka/actions)
 [![Coverage status](https://codecov.io/gh/riatelab/tanaka/branch/master/graph/badge.svg)](https://codecov.io/github/riatelab/tanaka?branch=master)
 ![N. Download](https://cranlogs.r-pkg.org/badges/grand-total/tanaka?color=brightgreen)  
-
+[![Project Status: Active – The project has reached a stable, usable
+state and is being actively
+developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 
 
 

diff --git a/codemeta.json b/codemeta.json
@@ -0,0 +1,133 @@
+{
+  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+  "@type": "SoftwareSourceCode",
+  "identifier": "tanaka",
+  "description": "The Tanaka method enhances the representation of topography on a map using shaded contour lines. In this simplified implementation of the method, north-west white contours represent illuminated topography and south-east black contours represent shaded topography. See Tanaka (1950) <doi:10.2307/211219>.",
+  "name": "tanaka: Design Shaded Contour Lines (or Tanaka) Maps",
+  "codeRepository": "https://github.com/riatelab/tanaka/",
+  "issueTracker": "https://github.com/riatelab/tanaka/issues/",
+  "license": "https://spdx.org/licenses/GPL-3.0",
+  "version": "0.3.0",
+  "programmingLanguage": {
+    "@type": "ComputerLanguage",
+    "name": "R",
+    "url": "https://r-project.org"
+  },
+  "runtimePlatform": "R version 4.2.1 (2022-06-23)",
+  "provider": {
+    "@id": "https://cran.r-project.org",
+    "@type": "Organization",
+    "name": "Comprehensive R Archive Network (CRAN)",
+    "url": "https://cran.r-project.org"
+  },
+  "author": [
+    {
+      "@type": "Person",
+      "givenName": "Timothée",
+      "familyName": "Giraud",
+      "email": "[email protected]",
+      "@id": "https://orcid.org/0000-0002-1932-3323"
+    }
+  ],
+  "maintainer": [
+    {
+      "@type": "Person",
+      "givenName": "Timothée",
+      "familyName": "Giraud",
+      "email": "[email protected]",
+      "@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"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "lwgeom",
+      "name": "lwgeom",
+      "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=lwgeom"
+    }
+  ],
+  "softwareRequirements": {
+    "1": {
+      "@type": "SoftwareApplication",
+      "identifier": "terra",
+      "name": "terra",
+      "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=terra"
+    },
+    "2": {
+      "@type": "SoftwareApplication",
+      "identifier": "sf",
+      "name": "sf",
+      "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=sf"
+    },
+    "3": {
+      "@type": "SoftwareApplication",
+      "identifier": "mapiso",
+      "name": "mapiso",
+      "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=mapiso"
+    },
+    "4": {
+      "@type": "SoftwareApplication",
+      "identifier": "grDevices",
+      "name": "grDevices"
+    },
+    "5": {
+      "@type": "SoftwareApplication",
+      "identifier": "graphics",
+      "name": "graphics"
+    },
+    "SystemRequirements": null
+  },
+  "fileSize": "633.939KB",
+  "releaseNotes": "https://github.com/riatelab/tanaka/blob/master/NEWS.md",
+  "readme": "https://github.com/riatelab/tanaka/blob/master/README.md",
+  "contIntegration": ["https://github.com/riatelab/tanaka/actions", "https://codecov.io/github/riatelab/tanaka?branch=master"],
+  "keywords": ["map", "r-package", "spatial", "tanaka"]
+}