Skip to content

Commit

Permalink
typo (#20)
Browse files Browse the repository at this point in the history
* typo

* one more
  • Loading branch information
rimhajal authored Jul 4, 2024
1 parent 91d1c9c commit df209b2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ hmd_rates
This `hmd_rates` rate table represents mortality rates extracted from the [Human Mortality Database (HMD)](https://mortality.org). The output of the REPL shows that we have a `RateTable` object with two covariates `:country` and `:sex`. You can query the available covariates of a given `RateTable` as such:

```@example 1
availlable_covariates(hmd_rates, :sex)
available_covariates(hmd_rates, :sex)
```

For this specific dataset, the number of countries is huge and calling `availlable_covariates(hmd_rates, :country)` won't be very useful. Thus, for convenience and only for this dataset we provided details on the country codes separately in another constant object called `hmd_countries`:
For this specific dataset, the number of countries is huge and calling `available_covariates(hmd_rates, :country)` won't be very useful. Thus, for convenience and only for this dataset we provided details on the country codes separately in another constant object called `hmd_countries`:

```@example 1
hmd_countries
Expand All @@ -52,7 +52,7 @@ Recall that the daily hazard rate of mortality is defined as $-\log(1 - q_x)/365
- The `date` parameter should be provided in days as well, with the same conversion factor.
- The format of other covariates may vary between rate tables, but it's essential to consider that their order is significant.

The `sex` covariate typically has values such as `:male` and `:female`, and sometimes `:total`. For the `hmd_rates` table, we have previously observed two additional covariates: `country` and `sex`. Recall that you can use the `availlable_covariates` function to obtain these informations.
The `sex` covariate typically has values such as `:male` and `:female`, and sometimes `:total`. For the `hmd_rates` table, we have previously observed two additional covariates: `country` and `sex`. Recall that you can use the `available_covariates` function to obtain these informations.

There are several querying syntax, all lowering to the same code. You are free to choose the syntax that you prefer. Depending on the querying syntax, the order of the passed arguments can be significant. For instance, the daily hazard rate for a Slovene male, on his 20th birthday, which happens to fall on the tenth of January 2010, can be queried using one of the following syntaxes:

Expand Down
2 changes: 1 addition & 1 deletion src/RateTable.jl
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ end

predictors(::BasicRateTable) = () # empty tuple.
predictors(rt::RateTable) = keys(rt.axes)
availlable_covariates(rt::RateTable, axe) = rt.axes[axe]
available_covariates(rt::RateTable, axe) = rt.axes[axe]

Base.getindex(rt::RateTable, arg) = rt.map[arg]
Base.getindex(rt::RateTable, args...) = rt.map[args]
Expand Down
2 changes: 1 addition & 1 deletion src/RateTables.jl
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export hmd_rates,
survexp_mn,
survexp_fr,
daily_hazard,
availlable_covariates,
available_covariates,
frpop,
Life,
expectation,
Expand Down

2 comments on commit df209b2

@rimhajal
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error while trying to register: Version 0.1.1 already exists

Please sign in to comment.