Skip to content

Commit 0cf7c55

Browse files
committed
finishing touches for 0.8.1
1 parent c0e423f commit 0cf7c55

File tree

13 files changed

+323
-294
lines changed

13 files changed

+323
-294
lines changed

NEWS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# codebook 0.8.1
2+
## Bugfixes
3+
- When errors occurred in the reliability computation, codebook would fail hard. It now fails with a warning
4+
and continues.
5+
- When variables of the same name existed in two datasets described in the same document, figures were overwritten.
6+
This is no longer the case, paths are dataset-name-prefixed now. Datasets are made "safe" for paths.
7+
18
# codebook 0.8.0
29
## Changes
310
- removed three vignettes

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ traceable to the version of the package you used, you might also want to cite
8383
the archived package DOI.
8484

8585
### Paper
86-
> Arslan, R. C. (in press). How to automatically document data with the codebook package to facilitate data re-use. Advances in Methods and Practices in Psychological Science. [doi:10.31234/osf.io/5qc6h](https://doi.org/10.31234/osf.io/5qc6h)
86+
> Arslan, R. C. (in press). How to automatically document data with the codebook package to facilitate data re-use. Advances in Methods and Practices in Psychological Science. [doi:10.1177/2515245919838783](https://doi.org/10.1177/2515245919838783) [Open Access Preprint](https://doi.org/10.31234/osf.io/5qc6h)
8787
8888
### Zenodo
8989
> Arslan, R. C. (2018). Automatic codebooks from survey metadata (2018). URL https://github.com/rubenarslan/codebook. [![DOI](https://zenodo.org/badge/109252375.svg)](https://zenodo.org/badge/latestdoi/109252375)

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,22 @@ status](http://www.r-pkg.org/badges/version-ago/codebook)](https://cran.r-projec
1111
[![codecov](https://codecov.io/gh/rubenarslan/codebook/branch/master/graph/badge.svg)](https://codecov.io/gh/rubenarslan/codebook)
1212
[![DOI](https://zenodo.org/badge/109252375.svg)](https://zenodo.org/badge/latestdoi/109252375)
1313

14-
*Automatic Codebooks from Survey Metadata Encoded in Attributes*
14+
*Automatic Codebooks from Metadata Encoded in Dataset Attributes*
1515

1616
## Description
1717

18-
Easily automate the following tasks to describe data frames: computing
18+
Easily automate the following tasks to describe data frames: - summarise
19+
the distributions, and labelled missings of variables graphically and
20+
using descriptive statistics - for surveys, compute and summarise
1921
reliabilities (internal consistencies, retest, multilevel) for
20-
psychological scales, summarise the distributions of scales and items
21-
graphically and using descriptive statistics, combine this information
22-
with metadata (such as item labels and labelled values) that is derived
23-
from R attributes. To do so, the package relies on ‘rmarkdown’ partials,
24-
so you can generate HTML, PDF, and Word documents. Codebooks are also
25-
available as tables (CSV, Excel,
26-
etc.).
22+
psychological scales, - combine this information with metadata (such as
23+
item labels and labelled values) that is derived from R attributes.
24+
25+
To do so, the package relies on ‘rmarkdown’ partials, so you can
26+
generate HTML, PDF, and Word documents. Codebooks are also available as
27+
tables (CSV, Excel, etc.) and in JSON-LD, so that search engines can
28+
find your data and index the
29+
metadata.
2730

2831
## Generate markdown codebooks from the attributes of the variables in your data frame
2932

@@ -99,15 +102,18 @@ new_codebook_rmd()
99102

100103
## Citation
101104

102-
To cite the package, you can cite the preprint, but to make your
103-
codebook traceable to the version of the package you used, you might
104-
also want to cite the archived package DOI.
105+
To cite the package, you can cite the paper (currently only the preprint
106+
is available to read), but to make your codebook traceable to the
107+
version of the package you used, you might also want to cite the
108+
archived package DOI.
105109

106-
### Preprint
110+
### Paper
107111

108-
> Arslan, R. C. (2018). How to automatically generate rich codebooks
109-
> from study metadata.
110-
> [doi:10.31234/osf.io/5qc6h](https://doi.org/10.31234/osf.io/5qc6h)
112+
> Arslan, R. C. (in press). How to automatically document data with the
113+
> codebook package to facilitate data re-use. Advances in Methods and
114+
> Practices in Psychological Science.
115+
> [doi:10.1177/2515245919838783](https://doi.org/10.1177/2515245919838783)
116+
> [Open Access Preprint](https://doi.org/10.31234/osf.io/5qc6h)
111117
112118
### Zenodo
113119

cran-comments.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
## Submission
2-
* Mainly fixes a few bugs and unclear language as pointed out by users
3-
* Also becomes a bit more robust
4-
* Sorry for the short interval between submissions, last one was minor to fix a duplicated vignette
2+
* Bugfix release
53

64
## Test environments
75
* local OS X install, R 3.5.2
8-
* Ubuntu 14.04 (on travis-ci), R-oldrel, R-release, R-devel
6+
* Ubuntu 16 (on travis-ci), R-oldrel, R-release, R-devel
97
* win-builder (devel, release, R-oldrel)
108
* Rhub
119
* Windows Server 2008 R2 SP1, R-devel, 32/64 bit

docs/articles/codebook.html

Lines changed: 254 additions & 250 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/codebook_qualtrics.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/codebook_sav.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)