Skip to content

Commit

Permalink
Update arrowload help file
Browse files Browse the repository at this point in the history
  • Loading branch information
rebkwok committed Jun 16, 2023
1 parent e983219 commit 3ba19df
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions libraries/arrowload.sthlp
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,26 @@ Syntax

arrowload filename [, options]

options Description
options Description
---------------------------------------------------------------------------------
Main
configfile(path/to/csv/file) A csv file containing configuration for the import
verbosity(#) An integer to control the level of output;
default verbosity(3)
---------------------------------------------------------------------------------


Description
-----------

arrowload loads an arrow file
arrowload loads an arrow file into the stata dataset.

Columns in the arrow file are converted to the most appropriate stata variable type.

NOTE: Integer types will be loaded as byte, int or long, depending on the values of the
column in the arrow data. If the arrow data contains integers that are larger than 32 bit,
which cannot be represented as an integer in stata, the column will be loaded as a
string column, and values will be string representations of the integers.


Options
Expand All @@ -35,10 +44,15 @@ Options
long for use in stata. However, it is preferable fix the input file to use valid
names. Some or all variable names can be mapped.

verbosity determine the level of output
- 1: prints minimal info messages
- 2: prints warnings only
- 3: prints all info messages (the default)


Examples
--------

. arrowload "/workspace/dataset.arrow"

. arrowload "/workspace/dataset.arrow", configfile("/workspace/config.csv")
. arrowload /workspace/dataset.arrow
. arrowload /workspace/dataset.arrow, verbosity(1)
. arrowload /workspace/dataset.arrow, configfile(/workspace/config.csv)
. arrowload /workspace/dataset.arrow, configfile(/workspace/config.csv) verbosity(2)

0 comments on commit 3ba19df

Please sign in to comment.