Skip to content

Commit f114968

Browse files
ThierryOThierryO
authored
Release version 0.4.0
2 parents c0fb058 + 1815ae3 commit f114968

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+1722
-1082
lines changed

‎.Rbuildignore

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1+
# checklist
2+
^_pkgdown.yml$
13
^.*\.Rproj$
2-
^\.Rproj\.user$
3-
^\.github$
4-
^codemeta\.json$
54
^.zenodo\.json$
6-
^man-roxygen$
7-
^pkgdown$
8-
^_pkgdown.yml$
9-
^docs$
10-
^cran-comments\.md$
11-
# checklist
5+
^\.github$
6+
^\.httr-oauth$
7+
^\.Rproj\.user$
8+
^\.zenodo\.json$
129
^checklist.yml$
10+
^CITATION\.cff$
1311
^codecov.yml$
14-
^LICENSE.md$
15-
^\.httr-oauth$
12+
^codecov\.yml$
13+
^codemeta\.json$
14+
^cran-comments\.md$
15+
^data-raw$
1616
^doc$
17+
^docs$
18+
^LICENSE.md$
19+
^man-roxygen$
1720
^Meta$
21+
^pkgdown$
22+
^README\.Rmd$

‎.github/workflows/check_on_branch.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
on:
22
push:
33
branches-ignore:
4+
- main
45
- master
56
- ghpages
67

@@ -10,8 +11,10 @@ jobs:
1011
check-package:
1112
runs-on: ubuntu-latest
1213
name: "check package"
14+
env:
15+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
16+
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
1317
steps:
1418
- uses: inbo/actions/check_pkg@master
1519
with:
16-
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
17-
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
20+
token: ${{ secrets.PAT }}

‎.github/workflows/check_on_different_r_os.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
on:
22
push:
33
branches:
4+
- main
45
- master
56
pull_request:
67
branches:
8+
- main
79
- master
810

9-
name: R-CMD-check
11+
name: R-CMD-check-OS
1012

1113
jobs:
1214
R-CMD-check:
@@ -21,10 +23,11 @@ jobs:
2123
- {os: macOS-latest, r: 'release'}
2224
- {os: windows-latest, r: 'release'}
2325
- {os: ubuntu-20.04, r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
24-
- {os: ubuntu-16.04, r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/xenial/latest"}
26+
- {os: ubuntu-20.04, r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"}
2527

2628
env:
2729
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
30+
_R_CHECK_SYSTEM_CLOCK_: false
2831
RSPM: ${{ matrix.config.rspm }}
2932
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
3033
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
@@ -61,6 +64,8 @@ jobs:
6164
Rscript -e "remotes::install_github('r-hub/sysreqs')"
6265
sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
6366
sudo -s eval "$sysreqs"
67+
sudo apt-get install -y libcurl4-openssl-dev
68+
6469
- name: Install dependencies
6570
run: |
6671
remotes::install_deps(dependencies = TRUE)
@@ -77,7 +82,7 @@ jobs:
7782
- name: Check
7883
env:
7984
_R_CHECK_CRAN_INCOMING_: false
80-
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
85+
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "error", check_dir = "check")
8186
shell: Rscript {0}
8287

8388
- name: Show testthat output
@@ -91,3 +96,4 @@ jobs:
9196
with:
9297
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
9398
path: check
99+
retention-days: 5

‎.github/workflows/check_on_main.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
- master
6+
schedule:
7+
- cron: '6 0 15 * *'
8+
9+
name: "check package on main"
10+
11+
jobs:
12+
check-package:
13+
runs-on: ubuntu-latest
14+
name: "check package"
15+
env:
16+
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
17+
ORCID_TOKEN: ${{ secrets.ORCID_TOKEN }}
18+
steps:
19+
- uses: inbo/actions/check_pkg@master
20+
with:
21+
token: ${{ secrets.PAT }}

‎.github/workflows/check_on_master.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎.github/workflows/release.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
on:
2+
push:
3+
tags:
4+
- 'v*'
5+
6+
name: Create Release
7+
8+
jobs:
9+
build:
10+
name: Create Release
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
- name: Get tag message
16+
run: |
17+
TAG_BODY=$(git tag --contains ${{ github.sha }} -n100 | awk '(NR>1)')
18+
echo "::set-output name=TAG_BODY::$TAG_BODY"
19+
id: tag-body
20+
- name: Create Release
21+
id: create_release
22+
uses: actions/create-release@v1
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
with:
26+
tag_name: ${{ github.ref }}
27+
release_name: Release ${{ github.ref }}
28+
body: ${{ steps.tag-body.outputs.TAG_BODY }}
29+
draft: false
30+
prerelease: false

‎.gitignore

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
.Rproj.user
2-
.Rhistory
1+
.httr-oauth
32
.RData
3+
.Rhistory
4+
.Rproj.user
45
.Ruserdata
5-
inst/doc
6-
docs
7-
.httr-oauth
6+
*.html
87
doc
8+
docs
9+
inst/doc
910
Meta

‎.zenodo.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"title": "git2rdata: Store and Retrieve Data.frames in a Git Repository",
3+
"version": "0.4.0",
4+
"description": "The git2rdata package is an R package for writing and reading dataframes as plain text files. A metadata file stores important information. 1) Storing metadata allows to maintain the classes of variables. By default, git2rdata optimizes the data for file storage. The optimization is most effective on data containing factors. The optimization makes the data less human readable. The user can turn this off when they prefer a human readable format over smaller files. Details on the implementation are available in vignette(\"plain_text\", package = \"git2rdata\"). 2) Storing metadata also allows smaller row based diffs between two consecutive commits. This is a useful feature when storing data as plain text files under version control. Details on this part of the implementation are available in vignette(\"version_control\", package = \"git2rdata\"). Although we envisioned git2rdata with a git workflow in mind, you can use it in combination with other version control systems like subversion or mercurial. 3) git2rdata is a useful tool in a reproducible and traceable workflow. vignette(\"workflow\", package = \"git2rdata\") gives a toy example. 4) vignette(\"efficiency\", package = \"git2rdata\") provides some insight into the efficiency of file storage, git repository size and speed for writing and reading.",
5+
"creators": [
6+
{
7+
"name": "Onkelinx, Thierry",
8+
"orcid": "https://orcid.org/0000-0001-8804-4216"
9+
}
10+
],
11+
"upload_type": "software",
12+
"access_right": "open",
13+
"license": "GPL-3.0",
14+
"communities": [
15+
{
16+
"identifier": "inbo"
17+
}
18+
],
19+
"contributors": [
20+
{
21+
"name": "Vanderhaeghe, Floris",
22+
"type": "ProjectMember",
23+
"orcid": "https://orcid.org/0000-0002-6378-6229"
24+
},
25+
{
26+
"name": "Desmet, Peter",
27+
"type": "ProjectMember",
28+
"orcid": "https://orcid.org/0000-0002-8442-8025"
29+
},
30+
{
31+
"name": "Lommelen, Els",
32+
"type": "ProjectMember",
33+
"orcid": "https://orcid.org/0000-0002-3481-5684"
34+
},
35+
{
36+
"name": "Research Institute for Nature and Forest",
37+
"type": "RightsHolder"
38+
},
39+
{
40+
"name": "Onkelinx, Thierry",
41+
"type": "ContactPerson",
42+
"orcid": "https://orcid.org/0000-0001-8804-4216"
43+
}
44+
],
45+
"language": "eng",
46+
"keywords": ["R package", "reproducible research", "version control"]
47+
}

‎CITATION.cff

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
cff-version: 1.2.0
2+
message: If you use this software, please cite it as below.
3+
authors:
4+
- family-names: Onkelinx
5+
given-names: Thierry
6+
orcid: https://orcid.org/0000-0001-8804-4216
7+
contact:
8+
- email: [email protected]
9+
family-names: Onkelinx
10+
given-names: Thierry
11+
- email: [email protected]
12+
name: Research Institute for Nature and Forest
13+
title: 'git2rdata: Store and Retrieve Data.frames in a Git Repository'
14+
version: 0.4.0
15+
abstract: The git2rdata package is an R package for writing and reading dataframes
16+
as plain text files. A metadata file stores important information. 1) Storing metadata
17+
allows to maintain the classes of variables. By default, git2rdata optimizes the
18+
data for file storage. The optimization is most effective on data containing factors.
19+
The optimization makes the data less human readable. The user can turn this off
20+
when they prefer a human readable format over smaller files. Details on the implementation
21+
are available in vignette("plain_text", package = "git2rdata"). 2) Storing metadata
22+
also allows smaller row based diffs between two consecutive commits. This is a useful
23+
feature when storing data as plain text files under version control. Details on
24+
this part of the implementation are available in vignette("version_control", package
25+
= "git2rdata"). Although we envisioned git2rdata with a git workflow in mind, you
26+
can use it in combination with other version control systems like subversion or
27+
mercurial. 3) git2rdata is a useful tool in a reproducible and traceable workflow.
28+
vignette("workflow", package = "git2rdata") gives a toy example. 4) vignette("efficiency",
29+
package = "git2rdata") provides some insight into the efficiency of file storage,
30+
git repository size and speed for writing and reading.
31+
license: GPL-3.0
32+
type: software
33+
repository-code: https://github.com/ropensci/git2rdata/
34+
identifiers:
35+
- type: url
36+
value: https://ropensci.github.io/git2rdata/
37+
keywords:
38+
- R package
39+
- reproducible research
40+
- version control

‎DESCRIPTION

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
11
Package: git2rdata
22
Title: Store and Retrieve Data.frames in a Git Repository
3-
Version: 0.3.1
4-
Authors@R:
5-
c(person(given = "Thierry",
6-
family = "Onkelinx",
7-
role = c("aut", "cre"),
8-
email = "[email protected]",
9-
comment = c(ORCID = "0000-0001-8804-4216")),
10-
person(given = "Floris",
11-
family = "Vanderhaeghe",
12-
role = "ctb",
13-
email = "[email protected]",
14-
comment = c(ORCID = "0000-0002-6378-6229")),
15-
person(given = "Peter",
16-
family = "Desmet",
17-
role = "ctb",
18-
email = "[email protected]",
19-
comment = c(ORCID = "0000-0002-8442-8025")),
20-
person(given = "Els",
21-
family = "Lommelen",
22-
role = "ctb",
23-
email = "[email protected]",
24-
comment = c(ORCID = "0000-0002-3481-5684")),
25-
person(given = "Research Institute for Nature and Forest",
26-
role = c("cph", "fnd"),
27-
email = "[email protected]"))
3+
Version: 0.4.0
4+
Authors@R: c(
5+
person("Thierry", "Onkelinx", , "[email protected]", role = c("aut", "cre"),
6+
comment = c(ORCID = "0000-0001-8804-4216")),
7+
person("Floris", "Vanderhaeghe", , "[email protected]", role = "ctb",
8+
comment = c(ORCID = "0000-0002-6378-6229")),
9+
person("Peter", "Desmet", , "[email protected]", role = "ctb",
10+
comment = c(ORCID = "0000-0002-8442-8025")),
11+
person("Els", "Lommelen", , "[email protected]", role = "ctb",
12+
comment = c(ORCID = "0000-0002-3481-5684")),
13+
person("Research Institute for Nature and Forest", , , "[email protected]", role = c("cph", "fnd"))
14+
)
2815
Description: The git2rdata package is an R package for writing and reading
2916
dataframes as plain text files. A metadata file stores important
3017
information. 1) Storing metadata allows to maintain the classes of
@@ -44,10 +31,10 @@ Description: The git2rdata package is an R package for writing and reading
4431
traceable workflow. vignette("workflow", package = "git2rdata") gives
4532
a toy example. 4) vignette("efficiency", package = "git2rdata")
4633
provides some insight into the efficiency of file storage, git
47-
repository size and speed for writing and reading. Please cite using
48-
<doi:10.5281/zenodo.1485309>.
34+
repository size and speed for writing and reading.
4935
License: GPL-3
50-
URL: https://ropensci.github.io/git2rdata/
36+
URL: https://ropensci.github.io/git2rdata/,
37+
https://github.com/ropensci/git2rdata/
5138
BugReports: https://github.com/ropensci/git2rdata/issues
5239
Depends:
5340
R (>= 3.5.0)
@@ -66,10 +53,9 @@ Suggests:
6653
VignetteBuilder:
6754
knitr
6855
Encoding: UTF-8
69-
Language: en-GB
70-
LazyData: true
56+
Language: eng
7157
Roxygen: list(markdown = TRUE)
72-
RoxygenNote: 7.1.1
58+
RoxygenNote: 7.1.2
7359
Collate:
7460
'clean_data_path.R'
7561
'datahash.R'
@@ -87,3 +73,4 @@ Collate:
8773
'rename_variable.R'
8874
'upgrade_data.R'
8975
'utils.R'
76+
'verify_vc.R'

0 commit comments

Comments
 (0)