Documentation ¶
Index ¶
- Variables
- type Client
- func (c *Client) AddMeasurementsToSampleInProcess(projectID, experimentID, processID string, simple bool, sm SampleMeasurements) (*Sample, error)
- func (c *Client) AddSampleAndFilesToProcess(projectID, experimentID string, simple bool, ...) (*Sample, error)
- func (c *Client) AddSampleToProcess(projectID, experimentID string, simple bool, connect ConnectSampleToProcess) (*Sample, error)
- func (c *Client) AddSamplesToProcess(projectID, experimentID string, connect ConnectSamplesToProcess) ([]Sample, error)
- func (c *Client) CreateExperiment(projectID, name, description string, inProgress bool) (*Experiment, error)
- func (c *Client) CreateProcess(projectID, experimentID, name, processType string, setups []Setup) (*Process, error)
- func (c *Client) CreateProject(name, description string) (*Project, error)
- func (c *Client) CreateSample(projectID, experimentID, name string, attributes []Property) (*Sample, error)
- func (c *Client) DeleteProject(projectID string) error
- func (c *Client) GetFileByPathInProject(filePath, projectID string) (*File, error)
- func (c *Client) GetProjectOverviewByName(name string) (*Project, error)
- func (c *Client) Login(userID, password string) error
- func (c *Client) UpdateExperimentProgressStatus(projectID, experimentID string, inProgress bool) error
- type ConnectSampleAndFilesToProcess
- type ConnectSampleToProcess
- type ConnectSamplesToProcess
- type Dataset
- type Experiment
- type File
- type FileAndDirection
- type Measurement
- type Process
- type Project
- type ProjectNote
- type ProjectTodo
- type ProjectUser
- type Property
- type Sample
- type SampleMeasurements
- type SampleProperty
- type SampleToConnect
- type Setup
- type SetupProperty
- type Timestamp
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrAuth = errors.New("authentication")
Functions ¶
This section is empty.
Types ¶
type Client ¶
func (*Client) AddMeasurementsToSampleInProcess ¶
func (*Client) AddSampleAndFilesToProcess ¶
func (*Client) AddSampleToProcess ¶
func (*Client) AddSamplesToProcess ¶
func (c *Client) AddSamplesToProcess(projectID, experimentID string, connect ConnectSamplesToProcess) ([]Sample, error)
func (*Client) CreateExperiment ¶
func (c *Client) CreateExperiment(projectID, name, description string, inProgress bool) (*Experiment, error)
func (*Client) CreateProcess ¶
func (*Client) CreateProject ¶
func (*Client) CreateSample ¶
func (*Client) DeleteProject ¶
func (*Client) GetFileByPathInProject ¶
func (*Client) GetProjectOverviewByName ¶
type ConnectSampleAndFilesToProcess ¶
type ConnectSampleAndFilesToProcess struct { ProcessID string SampleID string PropertySetID string Transform bool FilesByName []FileAndDirection FilesByID []FileAndDirection }
type ConnectSampleToProcess ¶
type ConnectSamplesToProcess ¶
type ConnectSamplesToProcess struct { ProcessID string Transform bool Samples []SampleToConnect }
type Experiment ¶
type Experiment struct { ID string `json:"id"` Name string `json:"name"` Owner string `json:"owner"` Description string `json:"description"` Birthtime Timestamp `json:"-"` // `json:"birthtime"` MTime Timestamp `json:"-"` // `json:"mtime"` Citations []string `json:"citations"` Collaborators []string `json:"collaborators"` Funding []string `json:"funding"` Goals []string `json:"goals"` Publications []string `json:"publications"` Papers []string `json:"papers"` Status string `json:"status"` Processes []*Process `json:"processes"` Samples []*Sample `json:"samples"` Datasets []*Dataset `json:"datasets"` }
Experiment is where the user does their work collecting data, creating the workflow, etc...
type FileAndDirection ¶
type Measurement ¶
type Process ¶
type Process struct { ID string `json:"id"` Name string `json:"name"` Owner string `json:"owner"` Description string `json:"description"` DoesTransform bool `json:"does_transform"` ProcessType string `json:"process_type"` Birthtime Timestamp `json:"-"` // `json:"birthtime"` MTime Timestamp `json:"-"` // `json:"mtime"` InputSamples []*Sample `json:"input_samples"` OutputSamples []*Sample `json:"output_samples"` Files []*File `json:"files"` TemplateID string `json:"template_id"` TemplateName string `json:"template_name"` }
type Project ¶
type Project struct { ID string `json:"id"` Name string `json:"name"` Owner string `json:"owner"` Description string `json:"description"` Birthtime Timestamp `json:"birthtime"` MTime Timestamp `json:"mtime"` FileCount int `json:"files"` Notes []*ProjectNote `json:"notes"` Experiments []*Experiment `json:"experiments"` Samples []*Sample `json:"samples"` Todos []*ProjectTodo `json:"todos"` Users []*ProjectUser `json:"users"` }
A Project is a container for holding experiments and files and setting up access controls
type ProjectNote ¶
type ProjectNote struct { ID string `json:"id"` Title string `json:"title"` Note string `json:"note"` Birthtime Timestamp `json:"-"` // `json:"birthtime"` MTime Timestamp `json:"-"` // `json:"mtime"` Owner string `json:"owner"` }
A ProjectNote is a note for a project
type ProjectTodo ¶
type ProjectTodo struct {
Title string `json:"title"`
}
ProjectTodo is a simple representation of a to-do. When a ProjectTodo is completed it is simply deleted from the server.
type ProjectUser ¶
type ProjectUser struct { UserID string `json:"user_id"` Fullname string `json:"fullname"` Birthtime Timestamp `json:"-"` // `json:"birthtime"` }
ProjectUser is a user that has access to the project
type Property ¶
type Property struct { ID string `json:"id,omitempty"` Name string `json:"name"` Description string `json:"description"` Measurements []Measurement `json:"measurements"` }
type SampleMeasurements ¶
type SampleMeasurements struct { SampleID string PropertySetID string Attributes []SampleProperty }
type SampleProperty ¶
type SampleProperty struct { Name string `json:"name"` ID string `json:"id,omitempty"` Measurements []Measurement `json:"measurements"` Metadata map[string]interface{} `json:"metadata"` }
type SampleToConnect ¶
type Setup ¶
type Setup struct { ID string `json:"id"` Name string `json:"name"` Attribute string `json:"attribute"` Properties []*SetupProperty `json:"properties"` }
type SetupProperty ¶
Source Files ¶
Click to show internal directories.
Click to hide internal directories.