Skip to content

Commit 6bd8586

Browse files
committed
chore: prepare for CRAN submission; update DESCRIPTION, add LICENSE and NEWS files, and include cran-comments
1 parent e23b8cb commit 6bd8586

6 files changed

Lines changed: 64 additions & 10 deletions

File tree

.Rbuildignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@
77
^_pkgdown.yml$
88
^doc$
99
^Meta$
10+
^cran-comments\.md$
11+
^LICENSE\.md$

DESCRIPTION

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
Package: surveytoolbox
22
Type: Package
33
Title: Useful Support Functions for Survey Analysis
4-
Version: 0.1.0.9000
5-
Author: Martin Chan
6-
Maintainer: Martin Chan <martinchan53@gmail.com>
4+
Version: 0.1.0
5+
Authors@R:
6+
person("Martin", "Chan", , "martinchan53@gmail.com", role = c("aut", "cre"))
77
URL: https://github.com/martinctc/surveytoolbox/
8-
Description: A collection of tools for analyzing and visualizing survey data in R. It includes functions for manipulating labels, creating data dictionaries, converting variable types, and more.
8+
BugReports: https://github.com/martinctc/surveytoolbox/issues
9+
Description: A collection of tools for analyzing and visualizing survey data
10+
in R. This package provides functions for manipulating variable and value
11+
labels commonly found in SPSS datasets, creating data dictionaries,
12+
converting variable types between labelled and standard R types, performing
13+
rowwise operations with 'dplyr' syntax, creating dummy variables from
14+
categorical data, and computing common survey metrics such as Net Promoter
15+
Score (NPS) and top-box/bottom-box transformations. It integrates seamlessly
16+
with the 'tidyverse' workflow and the 'haven' package for labelled data.
917
License: GPL-3
1018
Encoding: UTF-8
1119
LazyData: true

LICENSE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GNU General Public License v3.0
2+
3+
This package is licensed under the GNU General Public License version 3 (GPL-3).
4+
5+
For the full text of the license, see: https://www.gnu.org/licenses/gpl-3.0.en.html

NEWS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# surveytoolbox (development version)
2+
3+
# surveytoolbox 0.1.0
4+
5+
## New Features
6+
7+
* Initial CRAN release
8+
* Core functions for survey data manipulation:
9+
- `superspread()`, `superspread_count()`, `superspread_fill()` for creating dummy variables
10+
- `data_dict()` for creating data dictionaries from labelled data
11+
- `look_up()` for lookup table operations
12+
- `apply_row()` for rowwise operations with dplyr syntax
13+
- `box_it()` for creating top/bottom box variables
14+
- `as_nps()` and `as_nps_cat()` for NPS calculations
15+
- `test_chisq()` and `ttest_nps()` for statistical tests
16+
- Label manipulation functions: `set_varl()`, `set_vall()`, `recode_vallab()`, `extract_vallab()`
17+
- Data conversion functions: `char_to_lab()`, `lab_to_char()`, `chr_to_var()`
18+
- Utility functions: `clean_strings()`, `wrap_text()`, `timed_fn()`, `categorise()`
19+
- File operations: `sav_to_rds()`, `copy_df()`, `read_df()`
20+
- Scale transformations: `likert_convert()`, `likert_reverse()`, `maxmin()`
21+
22+
## Documentation
23+
24+
* Added vignettes: "Getting Started" and "surveytoolbox Walkthrough"
25+
* Full roxygen2 documentation for all exported functions

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55

66
R package containing tidy support functions for survey analysis.
77

8-
Currently under development!
9-
(First created 29 Dec 2018)
10-
11-
128
<img src="https://raw.githubusercontent.com/martinctc/surveytoolbox/master/icons/surveytoolbox_hex.svg" align="right" height = 150 width = 150/>
139

1410
------------------------------------------------------------------------
@@ -44,8 +40,7 @@ There is also a convenience function (`apply_row()`) for performing rowwise oper
4440

4541
### Installation
4642

47-
surveytoolbox is not released on CRAN (yet).
48-
You can install the latest development version from GitHub with:
43+
You can install surveytoolbox from GitHub with:
4944

5045
```R
5146
install.packages("devtools")

cran-comments.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## R CMD check results
2+
3+
0 errors | 0 warnings | 0 notes
4+
5+
## Test environments
6+
7+
* local Windows 11 install, R 4.4.x
8+
* GitHub Actions (ubuntu-latest, windows-latest, macos-latest)
9+
* R-hub (linux, windows, macos)
10+
11+
## Downstream dependencies
12+
13+
This is a new package with no downstream dependencies.
14+
15+
## Notes
16+
17+
* This is a first submission to CRAN.
18+
* The package includes Windows-specific clipboard functions (`copy_df()`, `read_df()`)
19+
that are documented as Windows-only and fail gracefully on other platforms.

0 commit comments

Comments
 (0)