package fred

You can search for identifiers within the package.

in-package search v0.2.0

fred
- Fred
  - Categories_query
  - Conf
  - Maps_query
  - Models
    
    Api_error
    
    Categories
    
    Filter
    
    Maps_regional_data
    
    Maps_series_data
    
    Maps_series_group
    
    Maps_shape_file
    
    Observations
    
    Release_dates
    
    Releases
    
    Search
    
    Series
    
    Sort_order
    
    Sources
    
    Tables
    
    Tags
    
    Vintage_dates
  - Releases_query
  - Series_query
  - Sources_query
  - Tags_query

Legend:
Library
Module
Module type
Parameter
Class
Class type

type observations = {

realtime_start : string;
realtime_end : string;
observation_start : string;
observation_end : string;
units : string;
output_type : int;
file_type : string;
order_by : string;
sort_order : string;
count : int;
offset : int;
limit : int;
observations : observation list;

}

Container for observations data

and observation = {

observation_realtime_start : string;
observation_realtime_end : string;
date : string;
value : string;

}

val observations_of_yojson : 
  Yojson.Safe.t ->
  observations Ppx_deriving_yojson_runtime.error_or

val observation_of_yojson : 
  Yojson.Safe.t ->
  observation Ppx_deriving_yojson_runtime.error_or

val pp_observations : 
  Ppx_deriving_runtime.Format.formatter ->
  observations ->
  Ppx_deriving_runtime.unit

val show_observations : observations -> Ppx_deriving_runtime.string

val pp_observation : 
  Ppx_deriving_runtime.Format.formatter ->
  observation ->
  Ppx_deriving_runtime.unit

val show_observation : observation -> Ppx_deriving_runtime.string

type units =

| Levels
| Change
| ChangeFromYearAgo
| PercentChange
| PercentChangeFromYearAgo
| CompoundedAnnualRateOfChange
| ContinuouslyCompoundedRateOfChange
| ContinuouslyCompoundedAnnualRateOfChange
| NaturalLog

Observation's units options

type frequency =

| Default
| Daily
| Weekly
| Biweekly
| Monthly
| Quarterly
| Semiannual
| Annual
| WeeklyEndingFriday
| WeeklyEndingThursday
| WeeklyEndingWednesday
| WeeklyEndingTuesday
| WeeklyEndingMonday
| WeeklyEndingSunday
| WeeklyEndingSaturday
| BiweeklyEndingWednesday
| BiweeklyEndingMonday

Observation's frequency options

type aggregation_method =

| Average
| Sum
| EndOfPeriod

Observation's aggregation method options

type output_type =

| ObservationsByRealTimePeriod
| ObservationsByVintageDateAllObservations
| ObservationsByVintageDateNewAndRevisedObservationsOnly
| ObservationsInitialReleaseOnly

Observation's output type method options

val units_to_string : units -> string

val frequency_to_string : frequency -> string

val aggregation_method_to_string : aggregation_method -> string

val output_type_to_string : output_type -> string