strohne / volker

Volker Package

Aye 👋

I'm sailing the data seas ⛵. My home ports are Greifswald, Münster, Mainz, and the Datavana.

volker's Issues

Percentages

Can we print interactive tables to switch between column, row or total shares?

RChecks

Fix all RCheck issues

Title and base for tables

Implement table titles and a base row

Always report missings in the base

Currently, some functions (for counts) provide a missings parameter. Others just skip missings. Suggestion:

• Always report missings in the plot subtitle, a table footer or print a warning
• For table functions, add a missings column (that is not included in the calculation of totals or percentages)
• The missings parameter should be FALSE by default. When set to TRUE, missings should be treated as normal values, included in plots and tables as normal categories.

Implement report_metrics and report_counts

Implement report_metrics and report_counts

Fix links to vignettes in the readme

Links to vignettes in the readme do not work: https://strohne.github.io/volker/index.html

Using vignette("introduction") or similar might help. See https://pkgdown.r-lib.org/articles/linking.html

Numbers for metric plots: Output the mean?

Numbers for metric plots: Output the mean?

Add ci for effect sizes

Some already come with ci, add for all

Make colorful messages

Use cli package to generate nice colorful messages in the check functions.

Link to cor functions in the help

Prüfen

• plot_counts
• plot_metrics
• tab_counts
• tab_metrics
• effects_counts
• effects_metrics

Binder

Show RMarkdowns with binder or https://binderhub.uni-muenster.de/

Tests: Compare tibbles, not only printed output

In test-labels.R, consider testing the data frames, not the printing result.

Reduce package size

Winbuilder says:

* checking CRAN incoming feasibility ... [12s] NOTE
...
Version contains large components

When building a source package, the rendered markdowns include big plots.

• Can we get rid of them?
• Can we reduce image size?
• Can we reduce the number of rendered plots?

Remove missings from tables

Default parameter in descriptive tables should be: no missings. Can the number of missings be printed below the table?

Focus one category

In plot_counts_one(), plot_counts_one_grouped() and plots_counts_items() we have a category parameter. Add the same parameter to the corresponding table functions. And allow cumulative counts for ordered values.

Support single categories and single columns in tab_counts_items

#' TODO: Reorder boolean categories: first TRUE, then FALSE
#' TODO: Support single columns

Negative values are not ommited

Due to a bug in the function data_rm_negatives, not all negative values were removed in the report, tab, plot, and effect functions.

The bug is fixed, but not yet deployed. As a workaround, install the latest development version or explicitly remove specific residual values.

The following option, if set before the original dataframe is converted to a vlkr dataframe, can be used as a workaround to remove residual values:

options(vlkr.na.numbers=c(-1,-2,-9))

Check input scales

For all plot / count / effects functions, check whether the scale of the input vars is as expected (e.g. metric for a metric table) and print appropriate warnings.

Warn if the data contains only NAs

Check whether a column contains only NA values and output a warning (by now, it fails with cryptic messages)

Filter zeros, don't dropp all NAs

In data_rm_zeros, all NAs are dropped. Limit to zeroed NAs.
Same for data_rm_negatives.

Add help file for Sosci API integration

Tutorial: show how to quickly analyze Sosci Survey data

Fix scrambled output in the introduction vignette

In https://strohne.github.io/volker/articles/introduction.html the codebook() function output is ugly:

Plot height in markdowns

Plot height is only calculated when using the report function. Implement a plot function for vlkr_plots that calculate and render the target height for other functions.

Build: Plots render differently on different machines

Remove plot / report tests from build?

Or tweak settings: rstudio/rstudio#7028

Customize colors

Support custom fill colors for ordered bar plots (VLKR_FILLGRADIENT).

For unordered:
theme_set(theme_vlkr(base_fill = list(
c("red"),
c("red","blue","green","magenta","black")))
)

Implement a parameter base_gradient.

Create pkgdown help pages

https://pkgdown.r-lib.org/

Keep levels even if a column was converted to character

See "Replace item labels" test in test-labels.R

Add examples to the function help

Add examples to the function help

Adding documentation descriptions for not yet implemented

Not yet implemented. The future will come.

Organize function index in help pages

Order function help and add headers

Release volker 1.0.0

First release:

• usethis::use_cran_comments()
• Update (aspirational) install instructions in README
• Proofread Title: and Description:
• Check that all exported functions have @return and @examples
• Check that Authors@R: includes a copyright holder (role 'cph')
• Check licensing of included files
• Review https://github.com/DavisVaughan/extrachecks

Prepare for release:

• git pull
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• urlchecker::url_check()
• devtools::build_readme()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Add preemptive link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• Finish blog post
• Tweet

Change effects to effect (plural -> singular)

For all effects_* functions, not for the parameter name

Flip stacked bars

In plot_counts_one_grouped, flip the plot when prop is changed to cols.

Getting started

Add a simple getting started section to the readme

Order of items and factor levels

In all plots and tables, keep item, value and factor order.

Revise examples in readme

For the readme: Create better tables and maybe plots, revise the layout. Can be directly created inside the README.Rmd

Add ci for stacked bar plots

See .plot_bars

Item order

Die Reihenfolge der Items kommt durcheinander:

ds <- tribble(
  ~f1, ~f2, ~f10,
  1,     1,    1,
  1,     2,    1,
  2,     2,    2
) 

plot_counts(ds, c(f1:f10))
tab_counts(ds, c(f1:f10))

Bei metrics klappt es:

plot_metrics(ds, c(f1:f10))
tab_metrics(ds, c(f1:f10))

Außerdem ist hier das Farbschema unschön. Besser differenzieren:

• bei nur zwei Werten türkis statt schwarz nehmen.
• bei x Werten dann schwarz dazu nehmen

Implement limits in plots

We have a limits parameter in metric plot function. It does nothin yet.

In zip tables, implement line breaks

In zip_tables implement line breaks as separator

Implement category-parameter

Implement category-parameter in plot_counts_one() as in all other plots methods for categorical data

Always put -2 / Weiß nicht to the right

In frequency plots, the value order may be changed (-1, +1). Keep the residual categories with negative values always as last category.

Release volker 2.0.0

Prepare for release:

• git pull
• Check current CRAN check results
• Check if any deprecation processes should be advanced, as described in Gradual deprecation
• Polish NEWS
• urlchecker::url_check()
• devtools::build_readme()
• devtools::check(remote = TRUE, manual = TRUE)
• devtools::check_win_devel()
• revdepcheck::revdep_check(num_workers = 4)
• Update cran-comments.md
• git push
• Draft blog post

Submit to CRAN:

• usethis::use_version('major')
• devtools::submit_cran()
• Approve email

Wait for CRAN...

• Accepted 🎉
• Add preemptive link to blog post in pkgdown news menu
• usethis::use_github_release()
• usethis::use_dev_version(push = TRUE)
• Finish blog post
• Tweet

Overview about parameteres

In the documentation (intro vignette?) show a table with all plot and tab functions in rows, all parameters in cols and x when a function supports the parameter.

Implement missing table and plot functions

We still need three basic functions to fill the gap of the scheme:

• tab_counts_items_grouped
• plot_counts_items_grouped
• tab_counts_items_cor

And two plot functions for correlations

• plot_metrics_items_cor
• plot_counts_items_cor

Markdown template

Add a markdown template with sensible defaults for creating reports:

• Knit options echo=F, include=T
• Load packages: tidyverse and volker
• Sections: Load data, prepare data, report

RChecks: no visible binding for global variable

RChecks: no visible binding for global variable

The .data pronoun does not work in select or rename...tidyselect does not like it.

Plot height: calculate differently if a plot has a caption

In reports, respect the title in plot height calculation

Show how to save and load a codebook

codes <- codebook(ds)
write_xlsx(codes,"codebook.xlsx")

Dann manuell anpassen und:

codes <- read_xlsx("codebook-new.xlsx")
ds<- labs_apply(codebook)