Skip to content

Commit 747651c

Browse files
refactor: allow labels to customizable by users in plot recipes (#409)
* refactor: allow labels to customizable by users in plot recipes * docs: add docs for explaining labels in plots * chore: add .vscode in .gitignore
1 parent a5fae78 commit 747651c

File tree

4 files changed

+102
-44
lines changed

4 files changed

+102
-44
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
*.jl.*.cov
33
*.jl.mem
44
Manifest.toml
5+
.vscode/
56

67
# Build artifacts for creating documentation generated by the Documenter package
78
docs/build/

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,7 @@ The follow methods require extra dependencies and will be loaded as package exte
7474

7575
## Plotting
7676

77-
DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase.
78-
Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them.
79-
80-
For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.
77+
DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them. For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.
8178

8279
The series types defined are:
8380

@@ -95,6 +92,8 @@ The series types defined are:
9592

9693
By and large, these accept the same keywords as their function counterparts.
9794

95+
Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color.
96+
9897
## Citing
9998

10099
If you use this software in your work, please cite:

docs/src/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,7 @@ The following methods require extra dependencies and will be loaded as package e
4444

4545
## Plotting
4646

47-
DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase.
48-
Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them.
49-
50-
For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.
47+
DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the `plot` command (or any other), since they have type recipes associated with them. For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.
5148

5249
The series types defined are:
5350

@@ -65,6 +62,8 @@ The series types defined are:
6562

6663
By and large, these accept the same keywords as their function counterparts.
6764

65+
Some keywords differ from regular plots. `label_interp` is used to label the interpolation line plot, while `label_data` labels the data points. By default, both are plotted in the same color.
66+
6867
## Citing
6968

7069
If you use this software in your work, please cite:

0 commit comments

Comments
 (0)