diff --git a/BioNameGenerator/Public/Get-RandomPhrase.ps1 b/BioNameGenerator/Public/Get-RandomPhrase.ps1 index b2ba870..9a32318 100644 --- a/BioNameGenerator/Public/Get-RandomPhrase.ps1 +++ b/BioNameGenerator/Public/Get-RandomPhrase.ps1 @@ -1,7 +1,7 @@ Function Get-RandomPhrase { <# .SYNOPSIS - This functions handles the request for random Keyword using the function "Get-KeywordFromDatabase" + This function Generates 2 or 3 random words and concatenate them with a delimiter .DESCRIPTION Returns one or more random generated words separated by a delimiter .EXAMPLE diff --git a/docs/en-US/Dicionaries.md b/docs/en-US/Dicionaries.md index 0a3a24a..49202fb 100644 --- a/docs/en-US/Dicionaries.md +++ b/docs/en-US/Dicionaries.md @@ -5,54 +5,13 @@ online version: schema: 2.0.0 --- -# Get-HelloWorld +# Dictionaries ## SYNOPSIS -Returns Hello world -## SYNTAX - -``` -Get-HelloWorld [[-Value] ] [] -``` +SQLite database used by the Module to store the keywords ## DESCRIPTION -Returns Hello world - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-HelloWorld -``` - -Runs the command - -## PARAMETERS - -### -Value -Parameter description can go here or above in format: .PARAMETER \ - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: GetHelloWorld -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS -### System.String -## NOTES +Contains several tables that are acessed by the private function`Get-KeywordFromDatabase` -## RELATED LINKS diff --git a/docs/en-US/Get-RandomKeyword.md b/docs/en-US/Get-RandomKeyword.md index 0a3a24a..9a37313 100644 --- a/docs/en-US/Get-RandomKeyword.md +++ b/docs/en-US/Get-RandomKeyword.md @@ -5,33 +5,62 @@ online version: schema: 2.0.0 --- -# Get-HelloWorld +# Get-RandomKeyword ## SYNOPSIS -Returns Hello world +This functions handles the request for random Keyword based using the function "Get-KeywordFromDatabase" ## SYNTAX ``` -Get-HelloWorld [[-Value] ] [] +Get-RandomKeyword [[-Dictionary] ] [] ``` ## DESCRIPTION -Returns Hello world +Returns a random Keyword from one of the following dictionaries: ["28kAdj", + "5kColors","Aminoacids","Animals","Books", + "Brazilian","Colors","Comp","Compounds","Elements", + "Fields","Generas","Lab","Metals","NF-Adj", + "NF-Names","Nobel","Nucleic","RPG","Species"] + ## EXAMPLES ### EXAMPLE 1 -``` -Get-HelloWorld +```powershell +Get-RandomKeyword -Dicitionary Nobel ``` -Runs the command +Returns a random Nobel winner ## PARAMETERS -### -Value -Parameter description can go here or above in format: .PARAMETER \ +### -Dictionary + +Specifies wich Dictiory use for finding random words + +Options: +DictName Description +- 28kAdj - 28.000 Adjectives +- 5kColors - 5.000 Color names +- Aminoacids - Aminoacids names +- Animals - Animals names +- Books - Important Biological Books +- Brazilian - Important Brazilian Scientists +- Colors - HTML5 Named Colors +- Comp - Computation related Keyworks +- Compounds - Chemical compounds name-parts +- Elements - Periodic table elements +- Fields - Fields Medal Laureates +- Generas - Bacterial Generas +- Lab - Laboratory related keywords +- Metals - Metals and Alloys names +- NF-Adj - Adjective List from Nextflow run ID +- NF-Names - Important Scientists from Newxtflow run ID +- Nobel - Nobel Laureates +- Nucleic - Nucleic Acid Bases +- RPG - Role Playing Games related Keywords +- Species - Bacterial Species ```yaml Type: String @@ -40,7 +69,7 @@ Aliases: Required: False Position: 1 -Default value: GetHelloWorld +Default value: Aminoacid Accept pipeline input: False Accept wildcard characters: False ``` @@ -48,11 +77,12 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). -## INPUTS ## OUTPUTS ### System.String +A random string from one of the Dictionaries + ## NOTES ## RELATED LINKS diff --git a/docs/en-US/Get-RandomPhrase.md b/docs/en-US/Get-RandomPhrase.md index 0a3a24a..8f0726a 100644 --- a/docs/en-US/Get-RandomPhrase.md +++ b/docs/en-US/Get-RandomPhrase.md @@ -5,33 +5,32 @@ online version: schema: 2.0.0 --- -# Get-HelloWorld +# Get-RandomPhrase ## SYNOPSIS -Returns Hello world +This function Generates 2 or 3 random words and concatenate them with a delimiter ## SYNTAX ``` -Get-HelloWorld [[-Value] ] [] +Get-RandomPhrase [[-Start] ] [[-Middle] ] [[-End] ] [] ``` ## DESCRIPTION -Returns Hello world - +Returns one or more random generated words separated by a delimiter ## EXAMPLES ### EXAMPLE 1 ``` -Get-HelloWorld + Get-RandomPhrase -Start Metals -Middle Nobel -End Species -Delimiter "-" ``` -Runs the command +Returns a random phrase joined by a delimiter, exemple output: `Flevorium-Koshiba-antibiotica` ## PARAMETERS -### -Value -Parameter description can go here or above in format: .PARAMETER \ +### -Start +Specifies the dictionary to be used for the first word, can be one of the dicitionaries or None ```yaml Type: String @@ -40,19 +39,65 @@ Aliases: Required: False Position: 1 -Default value: GetHelloWorld +Default value: Aminoacid Accept pipeline input: False Accept wildcard characters: False ``` +### -Middle +Specifies the dictionary to be used for the middle word, can be one of the dicitionaries or None + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -End +Specifies the dictionary to be used for the Last word, can be one of the dicitionaries or None + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: Generas +Accept pipeline input: False +Accept wildcard characters: False +``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +### -Delimiter +Specifies which string will be used as delimiter for the Phrase + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: "_" +Accept pipeline input: False +Accept wildcard characters: False + +``` ## INPUTS ## OUTPUTS ### System.String +A random string Joined by the specified Delimiter. ## NOTES ## RELATED LINKS