diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml new file mode 100644 index 0000000..1101b8f --- /dev/null +++ b/.github/workflows/R-CMD-check.yaml @@ -0,0 +1,85 @@ +# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag. +# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions +on: + push: + branches: + - main + - master + pull_request: + branches: + - main + - master + +name: R-CMD-check + +jobs: + R-CMD-check: + runs-on: ${{ matrix.config.os }} + + name: ${{ matrix.config.os }} (${{ matrix.config.r }}) + + strategy: + fail-fast: false + matrix: + config: + - {os: windows-latest, r: 'release'} + - {os: macOS-latest, r: 'release'} + - {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"} + - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"} + - {os: ubuntu-20.04, r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"} + + env: + R_REMOTES_NO_ERRORS_FROM_WARNINGS: true + RSPM: ${{ matrix.config.rspm }} + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v2 + + - uses: r-lib/actions/setup-r@v1 + with: + r-version: ${{ matrix.config.r }} + + - uses: r-lib/actions/setup-pandoc@v1 + + - name: Query dependencies + run: | + install.packages('remotes') + saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2) + writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version") + shell: Rscript {0} + + - name: Cache R packages + if: runner.os != 'Windows' + uses: actions/cache@v2 + with: + path: ${{ env.R_LIBS_USER }} + key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} + restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1- + + - name: Install system dependencies + if: runner.os == 'Linux' + run: | + while read -r cmd + do + eval sudo $cmd + done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "20.04"))') + + - name: Install dependencies + run: | + remotes::install_deps(dependencies = TRUE) + remotes::install_cran("rcmdcheck") + shell: Rscript {0} + + - name: Check + env: + _R_CHECK_CRAN_INCOMING_REMOTE_: false + run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check") + shell: Rscript {0} + + - name: Upload check results + if: failure() + uses: actions/upload-artifact@main + with: + name: ${{ runner.os }}-r${{ matrix.config.r }}-results + path: check diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000..1190d38 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,21 @@ +{ + "title": "codex: Datasets for Teaching Archaeology and Paleontology", + "description": "
Datasets for teaching quantitative approaches and modeling in archaeology and paleontology. This package provides several types of data, relating to typologies, cultural evolution, radiocarbon dating and paleoenvironments.
", + "creators": [ + { + "orcid": "0000-0001-5759-4944", + "affiliation": "Universit\u00e9 Bordeaux Montaigne", + "name": "Frerebeau, Nicolas" + } + ], + "language": "eng", + "keywords": [ + "archaeology", + "archaeological science", + "paleontology", + "r package" + ], + "upload_type": "software", + "license": "GPL-3.0+", + "access_right": "open" +} diff --git a/DESCRIPTION b/DESCRIPTION index 3da7ac2..1911c4e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: codex -Title: Datasets for Teaching Archaeology and Palaeontology -Version: 0.0.0.9000 +Title: Datasets for Teaching Archaeology and Paleontology +Version: 0.1.0 Authors@R: person(given = "Nicolas", family = "Frerebeau", diff --git a/R/codex-package.R b/R/codex-package.R index c2125f2..61717ca 100644 --- a/R/codex-package.R +++ b/R/codex-package.R @@ -2,7 +2,7 @@ #' \tabular{ll}{ #' \strong{Package:} \tab codex \cr #' \strong{Type:} \tab Package \cr -#' \strong{Version:} \tab 1.0.0 \cr +#' \strong{Version:} \tab 0.1.0 \cr #' \strong{License:} \tab GPL-3 \cr #' \strong{DOI:} \tab \href{https://doi.org/xxx}{xxx} #' } @@ -23,8 +23,8 @@ #' Université Bordeaux Montaigne\cr #' F-33607 Pessac cedex\cr #' France -#' @name dimensio-package -#' @aliases dimensio +#' @name codex-package +#' @aliases codex #' @docType package #' @keywords internal "_PACKAGE" diff --git a/README.Rmd b/README.Rmd index a521109..3355375 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,6 +16,10 @@ knitr::opts_chunk$set( # codex +[![R-CMD-check](https://github.com/tesselle/codex/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/codex/actions) + +[![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) +[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) Datasets for teaching quantitative approaches and modeling in archaeology and paleontology. This package provides several types of data, relating to typologies, diversity measurement, cultural evolution, radiocarbon dating and paleoenvironments. diff --git a/README.md b/README.md index 7487396..01d8881 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ # codex + +[![R-CMD-check](https://github.com/tesselle/codex/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/codex/actions) + +[![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) +[![Lifecycle: +stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) Datasets for teaching quantitative approaches and modeling in diff --git a/codemeta.json b/codemeta.json new file mode 100644 index 0000000..3f143cb --- /dev/null +++ b/codemeta.json @@ -0,0 +1,60 @@ +{ + "@context": [ + "https://doi.org/10.5063/schema/codemeta-2.0", + "http://schema.org" + ], + "@type": "SoftwareSourceCode", + "identifier": "codex", + "description": "Datasets for teaching quantitative approaches and\n modeling in archaeology and paleontology. This package provides\n several types of data, relating to typologies, cultural evolution,\n radiocarbon dating and paleoenvironments.", + "name": "codex: Datasets for Teaching Archaeology and Paleontology", + "codeRepository": "https://github.com/tesselle/codex", + "issueTracker": "https://github.com/tesselle/codex/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.0.3 (2020-10-10)", + "author": [ + { + "@type": "Person", + "givenName": "Nicolas", + "familyName": "Frerebeau", + "email": "nicolas.frerebeau@u-bordeaux-montaigne.fr", + "@id": "https://orcid.org/0000-0001-5759-4944" + } + ], + "contributor": {}, + "copyrightHolder": {}, + "funder": {}, + "maintainer": [ + { + "@type": "Person", + "givenName": "Nicolas", + "familyName": "Frerebeau", + "email": "nicolas.frerebeau@u-bordeaux-montaigne.fr", + "@id": "https://orcid.org/0000-0001-5759-4944" + } + ], + "softwareSuggestions": [], + "softwareRequirements": [ + { + "@type": "SoftwareApplication", + "identifier": "R", + "name": "R", + "version": ">= 2.10" + } + ], + "readme": "https://github.com/tesselle/codex/blob/master/README.md", + "fileSize": "1177.769KB", + "developmentStatus": ["https://www.repostatus.org/#active", "https://www.tidyverse.org/lifecycle/#stable"], + "keywords": [ + "archaeology", + "paleontology", + "r-package", + "datasets", + "archaeological-science" + ] +} diff --git a/man/dimensio-package.Rd b/man/codex-package.Rd similarity index 87% rename from man/dimensio-package.Rd rename to man/codex-package.Rd index 6d0bc23..dd05b98 100644 --- a/man/dimensio-package.Rd +++ b/man/codex-package.Rd @@ -1,11 +1,11 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/codex-package.R \docType{package} -\name{dimensio-package} -\alias{dimensio-package} +\name{codex-package} +\alias{codex-package} \alias{_PACKAGE} -\alias{dimensio} -\title{codex: Datasets for Teaching Archaeology and Palaeontology} +\alias{codex} +\title{codex: Datasets for Teaching Archaeology and Paleontology} \description{ Datasets for teaching quantitative approaches and modeling in archaeology and paleontology. This package provides @@ -16,7 +16,7 @@ Datasets for teaching quantitative approaches and \tabular{ll}{ \strong{Package:} \tab codex \cr \strong{Type:} \tab Package \cr -\strong{Version:} \tab 1.0.0 \cr +\strong{Version:} \tab 0.1.0 \cr \strong{License:} \tab GPL-3 \cr \strong{DOI:} \tab \href{https://doi.org/xxx}{xxx} }