Implement functions for endpoint: Series

[sboysel]

https://research.stlouisfed.org/docs/api/fred/#Series

The following endpoints need to be implemented properly and consistently in fredr:

• fredr_series() - Get an economic data series. (Feature/endpoint series #30)
• fredr_series_categories() - Get the categories for an economic data series. (Feature/endpoint series #30)
• fredr_series_observations() - Get the observations or data values for an economic data series. (Feature/function parameters (repo branch) #28)
• fredr_series_release() - Get the release for an economic data series. (Feature/endpoint series #30)
• fredr_series_search() - Get economic data series that match keywords. (Feature/function parameters (repo branch) #28)
• fredr_series_search_tags() - Get the tags for a series search. (Feature/function parameters (repo branch) #28)
• fredr_series_search_related_tags() - Get the related tags for a series search. (Feature/function parameters (repo branch) #28)
• fredr_series_tags() - Get the tags for an economic data series. (Feature/endpoint series #30)
• fredr_series_updates() - Get economic data series sorted by when observations were updated on the FRED® server. (Feature/endpoint series #30)
• fredr_series_vintagedates() - Get the dates in history when a series' data values were revised or new data values were released. (Feature/endpoint series #30)

The functions are to be implemented with explicit arguments for each parameter in the FRED API (see documentation for each endpoint and the discussion in #20).

[sboysel]

@DavisVaughan: Just as a heads up, I'm currently working on these functions in a local feature branch.

[DavisVaughan]

Sounds good. I see for the required Params you changed the default from nothing to null. I see the reason you did that (so you can pass to the validation function) but I'd like to ensure the user knows it's required ahead of time. We could either

A) add "required" by the parameter in the documentation

B) restructure the argument checking to be

if(is.missing(search_id)) stop(required_msg, call.=FALSE)
validate_required_param(search_id)

[sboysel]

The function validate_series_id() will throw the error if the user leaves series_id = NULL.

> fredr_series()
 Error: Argument `series_id` must be supplied. 

I don't think there are any endpoints where series_id is an optional parameter.

[DavisVaughan]

I guess im saying, if i was a user and was trying to use this pkg for the first time, how do I know what params are required in the function call the first time I use it? having all of the optional params as param = NULL and the required params as param is a clear way to do that. Or just add it in the docs as "required param" and leave param = NULL for the required params.

Just trying to be uber user friendly and not have the only way they can figure out what is or is not required be running into an error (even if its a helpful one!)

[sboysel]

I see. I'll go with option A in this PR.