Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package name change. #4

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
- name: Install test dependencies
run: julia --project=test/ -e 'using Pkg; Pkg.instantiate()'
- name: Run tests
run: julia --project=. -e 'using Pkg; Pkg.test("DtD", coverage=true)'
run: julia --project=. -e 'using Pkg; Pkg.test("MertonDtD", coverage=true)'
- name: Codecov
run: julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())'
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = "DtD"
name = "MertonDtD"
uuid = "620a49e7-8616-4433-bb70-8bd2d50b6aa2"
authors = ["Finance Research Group", "xKDR", "Ayush Patnaik"]
version = "0.1.0"
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# DtD
# MertonDtD

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://xKDR.github.io/DtD.jl/dev)
![Build Status](https://github.com/xKDR/DtD.jl/actions/workflows/ci.yml/badge.svg)
![Build Status](https://github.com/xKDR/DtD.jl/actions/workflows/documentation.yml/badge.svg)
[![codecov](https://codecov.io/gh/xKDR/DtD.jl/branch/main/graph/badge.svg?token=TCkDWBCTiB)](https://codecov.io/gh/xKDR/DtD.jl)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://xKDR.github.io/MertonDtD.jl/dev)
![Build Status](https://github.com/xKDR/MertonDtD.jl/actions/workflows/ci.yml/badge.svg)
![Build Status](https://github.com/xKDR/MertonDtD.jl/actions/workflows/documentation.yml/badge.svg)
[![codecov](https://codecov.io/gh/xKDR/MertonDtD.jl/branch/main/graph/badge.svg?token=TCkDWBCTiB)](https://codecov.io/gh/xKDR/MertonDtD.jl)

DtD is calculated as the difference between the market value of the assets of the firm and the face value of its debt, scaled by the standard deviation of the firm's asset value. While the face value of the debt of the firm is known, the market value of the assets is not.

Expand All @@ -14,11 +14,11 @@ The dtd function of the package implements the Merton Model to compute a measure
The dtd function in this package is a translated into Julia by looking at the [dtd function from ifrogs package in R](https://https://github.com/ifrogs/ifrogs/blob/master/R/dtd.R)

## To install:
add "https://github.com/xKDR/DtD.jl.git"
add "https://github.com/xKDR/MertonDtD.jl.git"

## Basic usage:
```julia
using DtD
using MertonDtD
marketcap = 100 # market capital of the firm
debt = 70 # threshold level of debt for the firm below which the firm will default
vol = 0.3 # equity volatility
Expand All @@ -45,7 +45,7 @@ We will benchmark the example shown above in R and Julia.
```
**Julia**
```julia
using DtD
using MertonDtD
using BenchmarkTools
@benchmark dtd(100, 70, 0.3, 0.1)
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DtD = "620a49e7-8616-4433-bb70-8bd2d50b6aa2"
MertonDtD = "620a49e7-8616-4433-bb70-8bd2d50b6aa2"
14 changes: 7 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
using DtD
using MertonDtD
using Documenter

DocMeta.setdocmeta!(DtD, :DocTestSetup, :(using DtD); recursive=true)
DocMeta.setdocmeta!(MertonDtD, :DocTestSetup, :(using MertonDtD); recursive=true)

makedocs(;
modules=[DtD],
modules=[MertonDtD],
authors="xKDR Forum",
repo="https://github.com/xKDR/DtD.jl/blob/{commit}{path}#{line}",
sitename="$DtD.jl",
repo="https://github.com/xKDR/MertonDtD.jl/blob/{commit}{path}#{line}",
sitename="$MertonDtD.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://xKDR.github.io/DtD.jl",
canonical="https://xKDR.github.io/MertonDtD.jl",
assets=String[],
),
pages=[
Expand All @@ -19,7 +19,7 @@ makedocs(;
)

deploydocs(;
repo="github.com/xKDR/DtD.jl",
repo="github.com/xKDR/MertonDtD.jl",
target = "build",
devbranch="main"
)
8 changes: 4 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
```@meta
CurrentModule = DtD
CurrentModule = MertonDtD
```

# DtD
# MertonDtD

Documentation for [DtD](https://github.com/DtD.jl).
Documentation for [MertonDtD](https://github.com/MertonDtD.jl).

DtD is calculated as the difference between the market value of the assets of the firm and the face value of its debt, scaled by the standard deviation of the firm's asset value. While the face value of the debt of the firm is known, the market value of the assets is not.

Expand All @@ -15,5 +15,5 @@ Exploiting the option nature of equity as a European call option on the underlyi
```

```@autodocs
Modules = [DtD]
Modules = [MertonDtD]
```
2 changes: 1 addition & 1 deletion src/DtD.jl → src/MertonDtD.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module DtD
module MertonDtD

using Distributions, Optim
export dtd
Expand Down
4 changes: 2 additions & 2 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using DtD
using MertonDtD
using Test

@testset "DtD.jl" begin
@testset "MertonDtD.jl" begin
tolerance = 1.0e-5

x = dtd(100, 70, 0.3, 0.1)
Expand Down