Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative names for miss_var_pct and friends (AKA naming things is hard) #171

Closed
njtierney opened this Issue Jun 6, 2018 · 1 comment

Comments

Projects
None yet
1 participant
@njtierney
Copy link
Owner

njtierney commented Jun 6, 2018

At the moment there are four functions that calculate the percent or proportion of variables/cases that have missings. The names are:

  • naniar::miss_var_pct(airquality)
  • naniar::miss_var_prop(airquality)
  • naniar::miss_case_pct(airquality)
  • naniar::miss_case_prop(airquality)

However, in order to make them consistent with n_miss and prop_miss, I think that it might be worth changing the names:

  • naniar::miss_var_pct(airquality)
  • naniar::pct_var_miss(airquality)
  • naniar::pct_miss_var(airquality)

  • naniar::miss_var_prop(airquality)
  • naniar::prop_var_miss(airquality)
  • naniar::prop_miss_var(airquality)

  • naniar::miss_case_pct(airquality)
  • naniar::pct_case_miss(airquality)
  • naniar::pct_miss_case(airquality)

  • naniar::miss_case_prop(airquality)
  • naniar::prop_case_miss(airquality)
  • naniar::prop_miss_case(airquality)

@njtierney njtierney added this to the V0.4.0 milestone Jun 6, 2018

@njtierney

This comment has been minimized.

Copy link
Owner Author

njtierney commented Jul 30, 2018

I am going to suggest the following changes:

current_names new_names
miss_case_pct pct_miss_case
miss_case_prop prop_miss_case
miss_var_pct pct_miss_var
miss_var_prop prop_miss_var
complete_case_pct pct_complete_case
complete_case_prop prop_complete_case
complete_var_pct pct_complete_var
complete_var_prop prop_complete_var

and I will soft-deprecate the old names.

njtierney added a commit that referenced this issue Jul 30, 2018

njtierney added a commit that referenced this issue Jul 30, 2018

Merge pull request #185 from njtierney/namechange-pct-miss-var
Deprecated old names of the scalar missingness summaries in favour of better names - fixes #171
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.