Skip to content

Commit

Permalink
improve document
Browse files Browse the repository at this point in the history
  • Loading branch information
kongdd committed Jul 23, 2023
1 parent efb0e36 commit 18c138b
Show file tree
Hide file tree
Showing 5 changed files with 120 additions and 88 deletions.
3 changes: 3 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ makedocs(
),
pages=[
"Introduction" => "index.md"
"R Base" => "RBase.md"
"Statistics" => "Statistics.md"
"Climate" => "Climate.md"
],
sitename="Ipaper.jl",
strict=false,
Expand Down
37 changes: 37 additions & 0 deletions docs/src/Climate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
```@contents
Pages = ["index.md"]
Depth = 3
```

## Thresholds

```@docs
cal_anomaly_quantile
cal_anomaly_clim
cal_threshold
```

```@docs
_cal_anomaly_3d
```

```@docs
cal_mTRS_base
cal_mTRS_full
cal_climatology_base
cal_climatology_full
```


```@docs
Ipaper.cal_mTRS_base!
Ipaper.cal_mTRS_base3!
Ipaper.NanQuantile_low
```


```@docs
cal_yearly_Tair
cal_warming_level
```
51 changes: 51 additions & 0 deletions docs/src/RBase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# R Base

```@contents
Pages = ["RBase.md"]
Depth = 3
```

## Strings

```@docs
str_extract
str_extract_all
str_replace
grepl
```

## Plots

```@docs
merge_pdf
show_pdf
```

## cmd

```@docs
dir
path_mnt
writelines
```

## R base

```@docs
duplicated
list
match2
```

### Missing

```@docs
drop_missing
to_missing
```

## Parallel

```@docs
isCurrentWorker
```
20 changes: 20 additions & 0 deletions docs/src/Statistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```@contents
Pages = ["Statistics.md"]
Depth = 3
```

## Quantile

```@docs
NanQuantile_3d!
movmean
linreg_simple
linreg_fast
```

## Statistics

```@docs
apply
```
97 changes: 9 additions & 88 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,15 @@
## Thresholds
# Ipaper in Julia (R base for Julia)

```@docs
cal_anomaly_quantile
cal_anomaly_clim
cal_threshold
```

```@docs
_cal_anomaly_3d
```
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://jl-spatial.github.io/Ipaper.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jl-spatial.github.io/Ipaper.jl/dev)
[![CI](https://github.com/jl-spatial/Ipaper.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/jl-spatial/Ipaper.jl/actions/workflows/CI.yml)
[![Codecov](https://codecov.io/gh/jl-spatial/Ipaper.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jl-spatial/Ipaper.jl)

```@docs
cal_mTRS_base
cal_mTRS_full
cal_climatology_base
cal_climatology_full
```
> Dongdong Kong
## Installation

```@docs
cal_mTRS_base!
cal_mTRS_base3!
NanQuantile_low
```


```@docs
cal_yearly_Tair
cal_warming_level
```

## Quantile

```@docs
NanQuantile_3d!
movmean
linreg_simple
linreg_fast
```


## Statistics

```@docs
apply
```

## Strings

```@docs
str_extract
str_extract_all
str_replace
grepl
```

## Plots

```@docs
merge_pdf
show_pdf
```

## cmd

```@docs
dir
path_mnt
writelines
```

## R base

```@docs
duplicated
list
match2
```

### Missing

```@docs
drop_missing
to_missing
```

## Parallel

```@docs
isCurrentWorker
using Pkg
Pkg.add(url="https://github.com/jl-spatial/Ipaper.jl")
```

0 comments on commit 18c138b

Please sign in to comment.