-
Notifications
You must be signed in to change notification settings - Fork 8
Description
As discussed with Logan, update the @param
documentation for the f
parameter in epi_slide
. The following are the points to address:
- Instead of “If a function,
f
must takex
, a data frame with the same column names as the original object; followed by any number of named arguments; and ending with...
“, the proper thing may be thatf
should takex
,g
/k
/key
/think-of-a-better-name
, and named args (dots don’t seem necessary; I think originally they were just there to absorb the unlistedg
). - Correct "same column names as the original object" --- we might only get the non-grouping columns here. [This raises a separate issue. We are feeding the user an
epi_df
viaf
that might not have the geo_value column as one might expect. Hopefully we can get away with it, but maybe this needs to be a properepi_df
or just atibble
instead.] - If you think it clarifies things, change “named arguments” -> “named arguments (which will be taken from
...
)“. - Make sure that the description of
g
above matches/resembles how?group_modify
describes such a parameter, if it makes sense. - In the docs for the
f
being a formula case, describe.y
in the same manner asg
, if.y
can indeed be used [I'm guessing that it is usable].
Originally mentioned in PR #85.
Metadata
Metadata
Assignees
Labels
No labels