Cow-says Gear (cow-says)

Overview

Summary

The CowSays gear is an demo utility gear that makes animals speak. It uses as an example to illustrate how our skeleton gear template (available at https://gitlab.com/flywheel-io/scientific-solutions/gears/templates/skeleton) can be used.

Cite

License: MIT

Classification

Category: converter

Gear Level:

• Project
• Subject
• Session
• Acquisition
• Analysis

[[TOC]]

Inputs

• text-input
  • Name: text-file
  • Type: file
  • Optional: False
  • Description: Text file for the animal.

Config

• debug

  • Name: debug
  • Type: boolean
  • Description: Log debug messages
  • Default: False

• animal

  • Name: animal
  • Type: string
  • Description: Type of animal
  • Default: cow

Outputs

This gear will generate an image of the selected animal along with the message from the input text file.

  ______________
< Flywheel rocks >
  ==============
            \
             \
               ^__^                             
               (oo)\_______                   
               (__)\       )\/\             
                   ||----w |           
                   ||     ||  

Usage

Description

This gear takes an input text file and print out the message in the text file along with selected animal type in the gear log.

File Specifications

text-file

A text file that contains message that user wish to be printed on the gear log

Workflow

A picture and description of the workflow

graph LR;
    A[Input-File]:::input --> C;
    C[Upload] --> D[Acquisition container];
    D:::container --> E((Gear));
    E:::gear --> F[Gear Log]:::container;
    
    classDef container fill:#57d,color:#fff
    classDef input fill:#7a9,color:#fff
    classDef gear fill:#659,color:#fff

Description of workflow

1. Upload file to an Acquisition container
2. Select file as input to cow-says gear
3. View the outputs of the gear in Gear Log

Contributing

[For more information about how to get started contributing to that gear, checkout CONTRIBUTING.md.]