study

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetStudyPath added in v1.0.0

func GetStudyPath(ID string) string

GetStudyPath returns the URL path to a study, agnostic of domain

func GetStudyURL added in v1.0.0

func GetStudyURL(ID string) string

GetStudyURL returns the full URL to a study using configuration

func NewCreateCommand

func NewCreateCommand(client client.API, w io.Writer) *cobra.Command

NewCreateCommand creates a new `study create` command to allow you to create a study

func NewCredentialsReportCommand added in v0.0.57

func NewCredentialsReportCommand(client client.API, w io.Writer) *cobra.Command

NewCredentialsReportCommand creates a new `study credentials-report` command to retrieve the credentials usage report for a study as CSV.

func NewDemographicExportCommand added in v1.0.0

func NewDemographicExportCommand(client client.API, w io.Writer) *cobra.Command

NewDemographicExportCommand creates a new `study demographic-export` command to trigger a demographic data export for all submissions in a study.

func NewDuplicateCommand

func NewDuplicateCommand(client client.API, w io.Writer) *cobra.Command

NewDuplicateCommand creates a new `study duplicate` command to duplicate an existing study.

func NewIncreasePlacesCommand

func NewIncreasePlacesCommand(client client.API, w io.Writer) *cobra.Command

NewIncreasePlacesCommand creates a new `study increase-places` command to allow you to increase the places on a study.

func NewListCommand

func NewListCommand(commandName string, client client.API, w io.Writer) *cobra.Command

NewListCommand creates a new `study list` command to give you details about your studies.

func NewSetCredentialPoolCommand added in v0.0.57

func NewSetCredentialPoolCommand(client client.API, w io.Writer) *cobra.Command

NewSetCredentialPoolCommand creates a new `study set-credential-pool` command to allow you to set or update the credential pool on a draft study.

func NewStudyCommand

func NewStudyCommand(client client.API, w io.Writer) *cobra.Command

NewStudyCommand creates a new `study` command

func NewSubmissionCountsCommand added in v1.0.0

func NewSubmissionCountsCommand(client client.API, w io.Writer) *cobra.Command

NewSubmissionCountsCommand creates a new `study submission-counts` command to retrieve submission counts grouped by status for a study.

func NewTestStudyCommand added in v1.0.0

func NewTestStudyCommand(client client.API, w io.Writer) *cobra.Command

NewTestStudyCommand creates a new `study test` command to create a test run of a study to validate configuration before going live.

func NewTransitionCommand

func NewTransitionCommand(client client.API, w io.Writer) *cobra.Command

NewTransitionCommand creates a new `study transition` command to allow you change the study status.

func NewUpdateCommand added in v0.0.61

func NewUpdateCommand(client client.API, w io.Writer) *cobra.Command

NewUpdateCommand creates a new `study update` command to allow you to update a study using a JSON template file.

func NewViewCommand

func NewViewCommand(client client.API, w io.Writer) *cobra.Command

NewViewCommand creates a new `study view` command to give you details about your studies.

func RenderStudy added in v1.0.0

func RenderStudy(study model.Study) string

RenderStudy will produce a detailed view of the selected study.

Types

type CreateOptions

type CreateOptions struct {
	Args         []string
	TemplatePath string
	Publish      bool
	Silent       bool
}

CreateOptions is the options for the creating a study command.

type IncreasePlacesOptions

type IncreasePlacesOptions struct {
	Args   []string
	Places int
}

IncreasePlacesOptions represents the options for the increase-places command.

type InteractiveRenderer added in v1.0.0

type InteractiveRenderer struct{}

InteractiveRenderer runs the bubbles UI framework to provide a rich UI experience for the user.

func (*InteractiveRenderer) Render added in v1.0.0

Render will render the list in an interactive manner.

type ListOptions

type ListOptions struct {
	Args        []string
	Fields      string
	Output      shared.OutputOptions
	ProjectID   string
	Status      string
	Underpaying bool
}

type ListView added in v1.0.0

type ListView struct {
	List    list.Model
	Studies map[string]model.Study
	Study   *model.Study
	Client  client.API
}

ListView is responsible for presenting a list view to the user.

func (ListView) Init added in v1.0.0

func (lv ListView) Init() tea.Cmd

Init will initialise the view.

func (ListView) Update added in v1.0.0

func (lv ListView) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update will update the view.

func (ListView) View added in v1.0.0

func (lv ListView) View() string

View will render the view.

type SetCredentialPoolOptions added in v0.0.57

type SetCredentialPoolOptions struct {
	Args             []string
	CredentialPoolID string
}

SetCredentialPoolOptions represents the options for the set-credential-pool command.

type SubmissionCountsOptions added in v1.0.0

type SubmissionCountsOptions struct {
	JSON           bool
	NonInteractive bool
}

SubmissionCountsOptions is the options for the submission-counts command.

type TransitionOptions

type TransitionOptions struct {
	Args   []string
	Action string
	Silent bool
}

TransitionOptions is the options for transitioning a study command.

type UpdateOptions added in v0.0.61

type UpdateOptions struct {
	Args         []string
	TemplatePath string
	Json         bool
	Silent       bool
}

UpdateOptions is the options for the update study command.

type ViewOptions

type ViewOptions struct {
	Args []string
	Web  bool
}

ViewOptions is the options for the detail view of a project.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL