Skip to content
This repository has been archived by the owner on Jan 30, 2025. It is now read-only.

Commit

Permalink
Change package name
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Feb 9, 2021
1 parent a8c854d commit aff93b0
Show file tree
Hide file tree
Showing 15 changed files with 51 additions and 50 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Before you make a substantial pull request, you should always file an issue and

* We recommend that you create a Git branch for each pull request (PR).
* Look at the Travis and AppVeyor build status before and after making changes. The `README` should contain badges for any continuous integration services used by the package.
* Look at the [style guide](https://github.com/tesselle/codex/blob/master/.github/CODING_STYLE.md) before making changes. Please don't restyle code that has nothing to do with your PR.
* Look at the [style guide](https://github.com/tesselle/folio/blob/master/.github/CODING_STYLE.md) before making changes. Please don't restyle code that has nothing to do with your PR.
* We use [roxygen2](https://cran.r-project.org/package=roxygen2).
* We use [testthat](https://cran.r-project.org/package=testthat). Contributions with test cases included are easier to accept.
* For user-facing changes, add a bullet to the top of `NEWS.Rmd` below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).

## Code of Conduct

Please note that the codex project is released with a [Contributor Code of Conduct](https://github.com/nfrerebeau/codex/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
Please note that the folio project is released with a [Contributor Code of Conduct](https://github.com/nfrerebeau/folio/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.

## Prefer to Email?

Expand Down
2 changes: 1 addition & 1 deletion .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "codex: Datasets for Teaching Archaeology and Paleontology",
"title": "folio: Datasets for Teaching Archaeology and Paleontology",
"description": "<p>Datasets for teaching quantitative approaches and modeling in archaeology and paleontology. This package provides several types of data related to broad topics (cultural evolution, radiocarbon dating, paleoenvironments, etc.), which can be used to illustrate statistical methods in the classroom (multivariate data analysis, compositional data analysis, diversity measurement, etc.).</p>",
"creators": [
{
Expand Down
8 changes: 4 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Package: codex
Package: folio
Title: Datasets for Teaching Archaeology and Paleontology
Version: 1.0.0
Authors@R:
Expand All @@ -16,9 +16,9 @@ Description: Datasets for teaching quantitative approaches and
illustrate statistical methods in the classroom (multivariate data
analysis, compositional data analysis, diversity measurement, etc.).
License: GPL (>= 3)
URL: https://codex.tesselle.org,
https://github.com/tesselle/codex
BugReports: https://github.com/tesselle/codex/issues
URL: https://folio.tesselle.org,
https://github.com/tesselle/folio
BugReports: https://github.com/tesselle/folio/issues
Depends:
R (>= 2.10)
Encoding: UTF-8
Expand Down
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# codex 1.0.0
# folio 1.0.0

* Add the `kommos` dataset (chemical data).
* Add the `chevelon` dataset (count data).
Expand All @@ -7,7 +7,7 @@
* Add the `arnold1949` dataset (historical radiocarbon dates; "curve of knows").
* Remove the `altamira` dataset.

# codex 0.1.0
# folio 0.1.0

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4476183.svg)](https://doi.org/10.5281/zenodo.4476183)

Expand Down
4 changes: 2 additions & 2 deletions R/carbon.R
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
#' Reimer, P. J., Baillie, M. G. L., Bard, E., Bayliss, A., Beck, J. W.,
#' Blackwell, P. G., Bronk Ramsey, C. \emph{et al.} (2009). IntCal09 and Marine09
#' Radiocarbon age Calibration Curves, 0-50,000 Years Cal BP.
#' \emph{Radiocarbon}, 51(4): 111150. \doi{10.1017/S0033822200034202}.
#' \emph{Radiocarbon}, 51(4): 1111-50. \doi{10.1017/S0033822200034202}.
#' @family radiocarbon dating
#' @keywords datasets
"intcal09"
Expand All @@ -57,7 +57,7 @@
#' Reimer, P. J., Bard, E. Bayliss, A., Beck, J. W., Blackwell, P. G.,
#' Bronk Ramsey, C., Buck, C. E. \emph{et al.} (2013). IntCal13 and Marine13
#' Radiocarbon age Calibration Curves 0-50,000 Years cal BP.
#' \emph{Radiocarbon}, 55(4): 186987. \doi{10.2458/azu_js_rc.55.16947}.
#' \emph{Radiocarbon}, 55(4): 1869-87. \doi{10.2458/azu_js_rc.55.16947}.
#' @family radiocarbon dating
#' @keywords datasets
"intcal13"
Expand Down
6 changes: 3 additions & 3 deletions R/codex-package.R → R/folio-package.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' @details
#' \tabular{ll}{
#' \strong{Package:} \tab codex \cr
#' \strong{Package:} \tab folio \cr
#' \strong{Type:} \tab Package \cr
#' \strong{Version:} \tab 1.0.0 \cr
#' \strong{License:} \tab GPL-3 \cr
Expand All @@ -23,8 +23,8 @@
#' Université Bordeaux Montaigne\cr
#' F-33607 Pessac cedex\cr
#' France
#' @name codex-package
#' @aliases codex
#' @name folio-package
#' @aliases folio
#' @docType package
#' @keywords internal
"_PACKAGE"
14 changes: 7 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ knitr::opts_chunk$set(
)
```

# codex
# folio

<!-- badges: start -->
[![R-CMD-check](https://github.com/tesselle/codex/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/codex/actions)
[![R-CMD-check](https://github.com/tesselle/folio/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/folio/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)
Expand All @@ -30,21 +30,21 @@ Datasets for teaching quantitative approaches and modeling in archaeology and pa

This package is for teaching purposes only: some datasets may be outdated.

When using **codex**, you must cite the relevant publications for each dataset (see the documentation).
When using **folio**, you must cite the relevant publications for each dataset (see the documentation).

## Installation

You can install the released version of **codex** from [CRAN](https://CRAN.R-project.org) with:
You can install the released version of **folio** from [CRAN](https://CRAN.R-project.org) with:

```{r cran-installation, eval=FALSE}
install.packages("codex")
install.packages("folio")
```

And the development version from [GitHub](https://github.com/) with:

```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_github("tesselle/codex")
remotes::install_github("tesselle/folio")
```

## Usage
Expand Down Expand Up @@ -82,4 +82,4 @@ abline(fit, col = "red")
```

## Contributing
Please note that the **codex** project is released with a [Contributor Code of Conduct](https://github.com/tesselle/codex/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
Please note that the **folio** project is released with a [Contributor Code of Conduct](https://github.com/tesselle/folio/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# codex
# folio

<!-- badges: start -->

[![R-CMD-check](https://github.com/tesselle/codex/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/codex/actions)
[![R-CMD-check](https://github.com/tesselle/folio/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/folio/actions)

[![Project Status: Active – The project has reached a stable, usable
state and is being actively
Expand All @@ -26,23 +26,23 @@ analysis, diversity measurement, etc.).
This package is for teaching purposes only: some datasets may be
outdated.

When using **codex**, you must cite the relevant publications for each
When using **folio**, you must cite the relevant publications for each
dataset (see the documentation).

## Installation

You can install the released version of **codex** from
You can install the released version of **folio** from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("codex")
install.packages("folio")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("tesselle/codex")
remotes::install_github("tesselle/folio")
```

## Usage
Expand Down Expand Up @@ -101,7 +101,7 @@ abline(fit, col = "red")

## Contributing

Please note that the **codex** project is released with a [Contributor
Please note that the **folio** project is released with a [Contributor
Code of
Conduct](https://github.com/tesselle/codex/blob/master/.github/CODE_OF_CONDUCT.md).
Conduct](https://github.com/tesselle/folio/blob/master/.github/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
url: https://codex.tesselle.org
url: https://folio.tesselle.org
development:
mode: auto

Expand Down
16 changes: 8 additions & 8 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
"http://schema.org"
],
"@type": "SoftwareSourceCode",
"identifier": "codex",
"identifier": "folio",
"description": "Datasets for teaching quantitative approaches and\n modeling in archaeology and paleontology. This package provides\n several types of data related to broad topics (cultural evolution,\n radiocarbon dating, paleoenvironments, etc.), which can be used to\n illustrate statistical methods in the classroom (multivariate data\n analysis, compositional data analysis, diversity measurement, etc.).",
"name": "codex: Datasets for Teaching Archaeology and Paleontology",
"codeRepository": "https://github.com/tesselle/codex",
"issueTracker": "https://github.com/tesselle/codex/issues",
"name": "folio: Datasets for Teaching Archaeology and Paleontology",
"codeRepository": "https://github.com/tesselle/folio",
"issueTracker": "https://github.com/tesselle/folio/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "1.0.0",
"programmingLanguage": {
Expand Down Expand Up @@ -47,8 +47,8 @@
"version": ">= 2.10"
}
],
"readme": "https://github.com/tesselle/codex/blob/master/README.md",
"fileSize": "1649.774KB",
"readme": "https://github.com/tesselle/folio/blob/master/README.md",
"fileSize": "1649.766KB",
"developmentStatus": ["https://www.repostatus.org/#active", "https://www.tidyverse.org/lifecycle/#stable"],
"keywords": [
"archaeology",
Expand All @@ -57,6 +57,6 @@
"datasets",
"archaeological-science"
],
"relatedLink": "https://codex.tesselle.org",
"releaseNotes": "https://github.com/tesselle/codex/blob/master/NEWS.md"
"relatedLink": "https://folio.tesselle.org",
"releaseNotes": "https://github.com/tesselle/folio/blob/master/NEWS.md"
}
3 changes: 2 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
## Test environments
* Local R installation: R 4.0.3
* Ubuntu 20.04 (on GitHub Actions): R devel, release, oldrel
* Windows (on GitHub Actions): R release
* Windows (on GitHub Actions and win-builder): R devel, release, oldrel
* MacOS (on GitHub Actions): R release

## R CMD check results

0 errors | 0 warnings | 1 note

* This is a new release.
* Some links in the documentation point to articles behind paywalls that may return a 403 error.
File renamed without changes.
18 changes: 9 additions & 9 deletions man/codex-package.Rd → man/folio-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/intcal09.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/intcal13.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit aff93b0

Please sign in to comment.