Documentation
¶
Index ¶
- func GetStudyPath(ID string) string
- func GetStudyURL(ID string) string
- func NewCreateCommand(client client.API, w io.Writer) *cobra.Command
- func NewCredentialsReportCommand(client client.API, w io.Writer) *cobra.Command
- func NewDemographicExportCommand(client client.API, w io.Writer) *cobra.Command
- func NewDuplicateCommand(client client.API, w io.Writer) *cobra.Command
- func NewIncreasePlacesCommand(client client.API, w io.Writer) *cobra.Command
- func NewListCommand(commandName string, client client.API, w io.Writer) *cobra.Command
- func NewSetCredentialPoolCommand(client client.API, w io.Writer) *cobra.Command
- func NewStudyCommand(client client.API, w io.Writer) *cobra.Command
- func NewSubmissionCountsCommand(client client.API, w io.Writer) *cobra.Command
- func NewTestStudyCommand(client client.API, w io.Writer) *cobra.Command
- func NewTransitionCommand(client client.API, w io.Writer) *cobra.Command
- func NewUpdateCommand(client client.API, w io.Writer) *cobra.Command
- func NewViewCommand(client client.API, w io.Writer) *cobra.Command
- func RenderStudy(study model.Study) string
- type CreateOptions
- type IncreasePlacesOptions
- type InteractiveRenderer
- type ListOptions
- type ListView
- type SetCredentialPoolOptions
- type SubmissionCountsOptions
- type TransitionOptions
- type UpdateOptions
- type ViewOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetStudyPath ¶ added in v1.0.0
GetStudyPath returns the URL path to a study, agnostic of domain
func GetStudyURL ¶ added in v1.0.0
GetStudyURL returns the full URL to a study using configuration
func NewCreateCommand ¶
NewCreateCommand creates a new `study create` command to allow you to create a study
func NewCredentialsReportCommand ¶ added in v0.0.57
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
NewDemographicExportCommand creates a new `study demographic-export` command to trigger a demographic data export for all submissions in a study.
func NewDuplicateCommand ¶
NewDuplicateCommand creates a new `study duplicate` command to duplicate an existing study.
func NewIncreasePlacesCommand ¶
NewIncreasePlacesCommand creates a new `study increase-places` command to allow you to increase the places on a study.
func NewListCommand ¶
NewListCommand creates a new `study list` command to give you details about your studies.
func NewSetCredentialPoolCommand ¶ added in v0.0.57
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 ¶
NewStudyCommand creates a new `study` command
func NewSubmissionCountsCommand ¶ added in v1.0.0
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
NewTestStudyCommand creates a new `study test` command to create a test run of a study to validate configuration before going live.
func NewTransitionCommand ¶
NewTransitionCommand creates a new `study transition` command to allow you change the study status.
func NewUpdateCommand ¶ added in v0.0.61
NewUpdateCommand creates a new `study update` command to allow you to update a study using a JSON template file.
func NewViewCommand ¶
NewViewCommand creates a new `study view` command to give you details about your studies.
func RenderStudy ¶ added in v1.0.0
RenderStudy will produce a detailed view of the selected study.
Types ¶
type CreateOptions ¶
CreateOptions is the options for the creating a study command.
type IncreasePlacesOptions ¶
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
func (r *InteractiveRenderer) Render(c client.API, studies client.ListStudiesResponse, w io.Writer) error
Render will render the list in an interactive manner.
type ListOptions ¶
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.
type SetCredentialPoolOptions ¶ added in v0.0.57
SetCredentialPoolOptions represents the options for the set-credential-pool command.
type SubmissionCountsOptions ¶ added in v1.0.0
SubmissionCountsOptions is the options for the submission-counts command.
type TransitionOptions ¶
TransitionOptions is the options for transitioning a study command.
type UpdateOptions ¶ added in v0.0.61
UpdateOptions is the options for the update study command.
type ViewOptions ¶
ViewOptions is the options for the detail view of a project.