search

rywhale / kiwisR

Provides a simplified method for bringing tidy data into R from KISTERS WISKI databases via KiWIS API.
Other
12 stars 2 forks source link

rename of "Timeseries Comment" field #9

Closed beatonan closed 5 years ago

beatonan commented 5 years ago

suggest renaming "Timeseries Comment" field to something without a space and possibly a name that is more consistent with previous naming e.g. "ts_name"

rywhale commented 5 years ago

@beatonan This was actually intentional. "Timeseries Comment" is the name of the return field in the KiWIS documentation and I'm trying to maintain consistency between the column names returned and the field names in the KiWIS docs. (screen shot from here under 'Returnable Fields').

image

I've made it so that the user has to specify the return field as it appears in the KiWIS documentation, e.g.

ki_timeseries_values(
    ...
    return_fields = c("Timeseries Comment", "Occurrance Count")
)

and then they get back columns matching these provided strings. I agree that it's an annoying inconsistency that the time series value return fields don't follow the same naming but I think we should stick with mirroring the KiWIS docs wherever possible anyways. Closing as I don't plan to change this.