Difference between revisions of "ParseNumber"

Revision as of 22:48, 9 September 2016

ParseNumber(x, badVal, decimal)

It converts text «x» to a numeric value, if it has a number format (including dates or time) that is valid in Analytica. If not, e.g. ParseNumber("hello"), it returns Null, or «badVal» if specified. If «x» is already a number, it just returns the value «x».

If «x» uses a comma for the decimal point, such as "3.14", specify the «decimal» parameter to be ','. («decimal» requires Analytica 5.0)

Library

Text Functions

Example

ParseNumber('3.14') → 3.14

ParseNumber( x, x ) { Keeps cells that don't parse as text }

ParseNumber('3,14', decimal:',') → 3.14

Notes

An array can be passed, in which each cell of the array is parsed.

ParseNumber is often useful when reading data from flat files, using ReadCsvFile or ReadTextFile. You don't need to use ParseNumber when using ParseCSV, since it parses it.

Coercion to numeric can be accomplished in Analytica in other ways. For example, you can declare a function parameter with the qualifiers "coerce numeric". Then a string value passed to that parameter is parsed. The calling variable needs to have a non-date number format, since the number format of the calling object determines how the value is interpreted.

History

ParseNumber is new to Analytica 4.2 as a built-in function, but an equivalent library function, ParseNum can be used in Analytica 4.1.
The «decimal» parameter was introduced in Analytica 5.0

@@ Line 3: / Line 3: @@
 [[Category:Doc Status D]] <!-- For Lumina use, do not change -->
-==ParseNumber(x) ==
+==ParseNumber(x'', badVal, decimal'') ==
-It converts text «x» to a numeric value, if it has a number format (including dates or time) that is valid in Analytica. If not, e.g.  <code>ParseNumber("hello")</code>, it returns [[Null]]..  If «x» is already a number, it just returns the value «x».
+It converts text «x» to a numeric value, if it has a number format (including dates or time) that is valid in Analytica. If not, e.g.  <code>ParseNumber("hello")</code>, it returns [[Null]], or «badVal» if specified.  If «x» is already a number, it just returns the value «x».
+If «x» uses a comma for the decimal point, such as <code>"3.14"</code>, specify the «decimal» parameter to be <code>','</code>.  («decimal» requires [[Analytica 5.0]])
 == Library ==
@@ Line 10: / Line 12: @@
 == Example ==
-:<code>ParseNumber("3.14") &rarr; 3.14</code>
+:<code>[[ParseNumber]]('3.14') &rarr; 3.14</code>
+:<code>[[ParseNumber]]( x, x )</code>  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{ ''Keeps cells that don't parse as text'' }
+:<code>[[ParseNumber]]('3,14', decimal:',') &rarr; 3.14</code>
 == Notes ==
 An array can be passed, in which each cell of the array is parsed.
-[[ParseNumber]] is often useful when reading data from flat files, using [[ReadCsvFile]] or [[ReadTextFile]].
+[[ParseNumber]] is often useful when reading data from flat files, using [[ReadCsvFile]] or [[ReadTextFile]]. You don't need to use [[ParseNumber]] when using [[ParseCSV]], since it parses it.
 Coercion to numeric can be accomplished in Analytica in other ways.  For example, you can declare a function parameter with the [[Function Parameter Qualifiers|qualifiers]] "coerce numeric".  Then a string value passed to that parameter is parsed.  The calling variable needs to have a non-date number format, since the number format of the calling object determines how the value is interpreted.
 ==History==
-[[ParseNumber]] is new to [[What's new in Analytica 4.2?|Analytica 4.2]] as a built-in function, but an equivalent library function, [[ParseNum]] can be used in Analytica 4.1.
+* [[ParseNumber]] is new to [[What's new in Analytica 4.2?|Analytica 4.2]] as a built-in function, but an equivalent library function, [[ParseNum]] can be used in Analytica 4.1.
+* The «decimal» parameter was introduced in [[Analytica 5.0]]
 == See Also ==