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

add %Y M %M and %M M %Y formats #221

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

davidtedfordholt
Copy link
Contributor

used the structure of yearquarter() specification, addresses #142

used the structure of `yearquarter()` specification, addresses tidyverts#142
R/yearmonth.R Outdated
assertDate(x)
new_yearmonth(anydate(x))
key_words <- regmatches(x, gregexpr("[[:alpha:]]+", x))
if (all(grepl("^[[:digit:]]{1~4}[[:space:]]*(m|mon|month)[[:space:]]*[[:digit:]]{1~4}$",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you assign the regular expression to a variable?
Is it too strict to include [[:space:]] here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason to include [[:space]]* is to allow the possibility, since I've seen both 2018M01 and 2018 M01. I haven't seen 2018M 1 before, but it's easy enough to allow for, and I can imagine 2018 month 1 in a spreadsheet (probably created by concatenation).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The initial reason I decided to go with such a strict format compared to the quarterly thing, honestly, is that m is a far more common letter than q. I'm far more worried about something that isn't a date but looks like one for the first few lines with m than q.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've assigned the regular expression to a variable in a subsequent commit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Including [[:space:]]* doesn't seem to make any difference between 2018M01 and 2018M01. Can you remove [[:space:]]*?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and done.

Copy link
Member

@earowang earowang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for helping with the issue.
Can you also include a couple of unit tests in the PR? Thanks.

yr_mon <- regmatches(x, gregexpr("[[:digit:]]+", x))
digits_lgl <- map_lgl(yr_mon, ~ !has_length(.x, 2))
digits_len <- map_int(yr_mon, ~ sum(nchar(.x)))
digits_ind <- nchar(flatten_chr(yr_mon))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this line exactly do? Why it can't be length of 3?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we allow years before 1000AD using this format, there is no way to tell the difference between %y and %Y for 2-digit years. Also, it seems more likely that a 3-digit year specification is an error than that it refers to a year before 1000AD (especially using this format).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to throw an error for 3-digit years for now. If there's a compelling use case using 3-digit years, we'll accomodate this later.

@davidtedfordholt
Copy link
Contributor Author

Will do when I get up!

Creating a `yearmonth()` before January 1, 1000 AD will fail, if you use the %Ym%M format. I accept this shortcoming.
add tests for %Ym%M yearmonth()
Copy link
Member

@earowang earowang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank.

  1. Can you add yourself as a contributor to the authors field?
  2. Can you draft a news item that improves yearmonth(), including the issue number and your gh handle.

@@ -12,6 +12,17 @@ test_that("input types for yearmonth()", {
expect_identical(yearmonth(c(596, 576)), expected)
})

test_that("%Ym%M format for yearmonth()", {
expect_identical(yearmonth("2018 M01"), yearmonth("2018 Jan"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This unit test fails on gh CI.

Comment on lines +20 to +22
expect_error(yearmonth("201M1"))
expect_error(yearmonth("2018M13"))
expect_error(yearmonth("201M811"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you include the error msg you expect?

expect_error(yearmonth("201M1"))
expect_error(yearmonth("2018M13"))
expect_error(yearmonth("201M811"))
expect_error(yearmonth(c("2018M1", "2018 Feb", "2018M3")))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I think they are valid inputs, although a mixture of styles. I'll leave comments above to allow for this.

Comment on lines +81 to +88
if (any(mon > 12)) {
abort("Months can't be greater than 12.")
}
yearmonth(12 * (yr - 1970) + mon - 1)
} else {
assertDate(x)
new_yearmonth(anydate(x))
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (any(mon > 12)) {
abort("Months can't be greater than 12.")
}
yearmonth(12 * (yr - 1970) + mon - 1)
} else {
assertDate(x)
new_yearmonth(anydate(x))
}
x <- paste(yr, mon)
}
assertDate(x)
new_yearmonth(anydate(x))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants