Skip to content

Commit

Permalink
README.md: Make it clear that CairoMakie needs to be loaded for plott…
Browse files Browse the repository at this point in the history 
…ing.
  • Loading branch information
@mashu
mashu committed Oct 13, 2024
1 parent 2ebeb71 commit 081d5c2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "LineageCollapse"
uuid = "e38bdfdf-80f5-4f0c-93e0-53dd02ee37b8"
authors = ["Mateusz Kaduk <mateusz.kaduk@gmail.com> and contributors"]
version = "0.0.2"
version = "0.0.3"

[deps]
BioSequences = "7e6ae17a-c86d-528c-b3b9-7f778a29fe59"
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ LineageCollapse.jl is a high-performance Julia package for performing soft linea
- Fast and memory-efficient processing of large-scale immune repertoire data
- Implements a "soft" lineage collapsing algorithm
- Supports AIRR-compliant input data formats
- Flexible parameter configuration for customized analysis
- Built-in visualization tools for diagnostic plots
- Optional visualization with diagnostic plots
- Multithreaded processing for improved performance on multi-core systems

## Installation
Expand All @@ -37,7 +36,8 @@ preprocessed_df = preprocess_data(df)
collapsed_df = process_lineages(preprocessed_df)

# Generate diagnostic plots
plot_diagnostics(collapsed_df)
# using CairoMakie
# plot_diagnostics(collapsed_df)
```

## Input Requirements
Expand Down

2 comments on commit 081d5c2

@mashu
Copy link
Owner Author

@mashu mashu commented on 081d5c2 Oct 13, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Release notes:

Plotting functionality is now optional, and CairoMakie is no longer a required dependency for the software package.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/117213

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.0.3 -m "<description of version>" 081d5c2c5be77aa7ee395aba352422cce0e678f2
git push origin v0.0.3

Please sign in to comment.