diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index f26b37c..402cf55 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-02-14T09:20:01","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-02-27T18:20:10","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index eccde95..65015e2 100644 --- a/dev/index.html +++ b/dev/index.html @@ -125,4 +125,4 @@ 39999 │ 2021 109 1912.0 6.89 0.96 7.85 40000 │ 2021 109 1911.0 4.7 0.63 5.33 40001 │ 2021 110 0.0 9.13 0.68 9.81 - 39952 rows omitted

Package Features

TODO

Documentation

HMD.get_countries — Method

get_countries()::Dict{String, String}

Returns a Dictionary of valid countries and territories (i.e "Australia", "Austria", etc.)

source
HMD.get_groups — Method

get_groups()::Vector{String}

Returns a Vector of valid groupings (i.e. "1x1", "1x5", etc.)

source
HMD.get_tables — Method

get_tables()::Dict{String, String}

Returns a Dictionary of valid tables (i.e. "Births", "Deaths", etc.).

source
HMD.read_HMD — Method

read_HMD(country::String, tbl::String, grp::String, username::String, password::String; save=false, verbose=false)::Union{Nothing, DataFrame}

Takes as input the country, table, interval and user credentials.

  • country the country OR country code – see get_country() for a full list
  • tbl the chosen table OR table code – see get_table() for a full list
  • grp one of "1x1", "1x5", "1x10" – depending on combination with tbl
  • username email address when registering
  • password password when registering

Optional:

  • save a Boolean keyword to save to a CSV
  • verbose for progress logs

Returns a DataFrame object if successful.

source
HMD.read_HMD — Method

read_HMD(file_name::String; save=false, verbose=false)::Union{Nothing, DataFrame}

Takes as input the location of a .txt file downloaded from https://www.mortality.org/ and stored locally

Optional:

  • save a Boolean keyword to save to a CSV
  • verbose for progress logs

Returns a DataFrame object containing the data.

source
HMD.transform — Method

transform(df::DataFrame, col::Symbol)::Union{Nothing, DataFrame}

Returns a DataFrame structured age x year for a given feature (e.g. :Total)

source
+ 39952 rows omitted

Package Features

TODO

Documentation

HMD.get_countries — Method

get_countries()::Dict{String, String}

Returns a Dictionary of valid countries and territories (i.e "Australia", "Austria", etc.)

source
HMD.get_groups — Method

get_groups()::Vector{String}

Returns a Vector of valid groupings (i.e. "1x1", "1x5", etc.)

source
HMD.get_tables — Method

get_tables()::Dict{String, String}

Returns a Dictionary of valid tables (i.e. "Births", "Deaths", etc.).

source
HMD.read_HMD — Method

read_HMD(country::String, tbl::String, grp::String, username::String, password::String; save=false, verbose=false)::Union{Nothing, DataFrame}

Takes as input the country, table, interval and user credentials.

  • country the country OR country code – see get_country() for a full list
  • tbl the chosen table OR table code – see get_table() for a full list
  • grp one of "1x1", "1x5", "1x10" – depending on combination with tbl
  • username email address when registering
  • password password when registering

Optional:

  • save a Boolean keyword to save to a CSV
  • verbose for progress logs

Returns a DataFrame object if successful.

source
HMD.read_HMD — Method

read_HMD(file_name::String; save=false, verbose=false)::Union{Nothing, DataFrame}

Takes as input the location of a .txt file downloaded from https://www.mortality.org/ and stored locally

Optional:

  • save a Boolean keyword to save to a CSV
  • verbose for progress logs

Returns a DataFrame object containing the data.

source
HMD.transform — Method

transform(df::DataFrame, col::Symbol)::Union{Nothing, DataFrame}

Returns a DataFrame structured age x year for a given feature (e.g. :Total)

source