model

Documentation

Index

• Variables
• type Estimate
• type Forecast
• type Metadata
• type NewEstimate
• type NewForecast
• type NewOutcome
• type NewProbability
• type Outcome
• type Probability
• type Resolution
  • func (e Resolution) IsValid() bool
  • func (e Resolution) MarshalGQL(w io.Writer)
  • func (e Resolution) String() string
  • func (e *Resolution) UnmarshalGQL(v interface{}) error

Variables

var AllResolution = []Resolution{
	ResolutionResolved,
	ResolutionNotApplicable,
	ResolutionUnresolved,
}

Types

type Estimate

type Estimate struct {
	ID            string         `json:"id"`
	Created       time.Time      `json:"created"`
	Reason        string         `json:"reason"`
	Probabilities []*Probability `json:"probabilities"`
	BrierScore    *float64       `json:"brierScore,omitempty"`
}

A list of probabilities (one for each outcome) together with a timestamp and an explanation why you made this estimate. Every time you change your mind about a forecast you will create a new Estimate. All probabilities always add up to 100.

type Forecast

type Forecast struct {
	ID          string    `json:"id"`
	Title       string    `json:"title"`
	Description string    `json:"description"`
	Created     time.Time `json:"created"`
	// The point in time at which you predict you will be able to resolve whether
	// how the forecast resolved.
	Resolves time.Time `json:"resolves"`
	// The point in time at which you no longer want to update your probability
	// estimates for the forecast. In most cases you won't need this. One example
	// where you might is when you want to predict the outcome of an exam. You may
	// want to set 'closes' to the time right before the exam starts, even though
	// 'resolves' is several weeks later (when the exam results are published). This
	// way your prediction history will only reflect your estimations before you
	// took the exam, which is something you may want (or not, in which case you
	// could simply not set 'closes').
	Closes     *time.Time  `json:"closes,omitempty"`
	Resolution Resolution  `json:"resolution"`
	Estimates  []*Estimate `json:"estimates"`
}

A prediction about the future.

type Metadata

type Metadata struct {
	Version string `json:"version"`
}

Information about the application itself e.g. the current version.

type NewEstimate

type NewEstimate struct {
	Reason        string            `json:"reason"`
	Probabilities []*NewProbability `json:"probabilities"`
	// An optional date in the past when you created this estimate. This can be
	// useful for cases when you wrote it down on a piece of paper or when importing
	// from other software. When creating a new Forecast this value will be for
	// the first Estimate (which will get the same timestamp as the
	// Forecast.Created).
	Created *time.Time `json:"created,omitempty"`
}

type NewForecast

type NewForecast struct {
	Title       string     `json:"title"`
	Description string     `json:"description"`
	Resolves    time.Time  `json:"resolves"`
	Closes      *time.Time `json:"closes,omitempty"`
	// An optional date in the past when you created this forecast. This can be
	// useful for cases when you wrote it down on a piece of paper or when importing
	// from other software.
	Created *time.Time `json:"created,omitempty"`
}

type NewOutcome

type NewOutcome struct {
	Text string `json:"text"`
}

type NewProbability

type NewProbability struct {
	Value   int         `json:"value"`
	Outcome *NewOutcome `json:"outcome"`
}

type Outcome

type Outcome struct {
	ID      string `json:"id"`
	Text    string `json:"text"`
	Correct bool   `json:"correct"`
}

The possible results of a forecast. In the simplest case you will only have two outcomes: Yes and No.

type Probability

type Probability struct {
	ID      string   `json:"id"`
	Value   int      `json:"value"`
	Outcome *Outcome `json:"outcome"`
}

A number between 0 and 100 tied to a specific Outcome. It is always part of an Estimate.

type Resolution

type Resolution string

const (
	ResolutionResolved      Resolution = "RESOLVED"
	ResolutionNotApplicable Resolution = "NOT_APPLICABLE"
	ResolutionUnresolved    Resolution = "UNRESOLVED"
)

func (Resolution) IsValid

func (e Resolution) IsValid() bool

func (Resolution) MarshalGQL

func (e Resolution) MarshalGQL(w io.Writer)

func (Resolution) String

func (e Resolution) String() string

func (*Resolution) UnmarshalGQL

func (e *Resolution) UnmarshalGQL(v interface{}) error