Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Updated readme, citation.cff, user guide and methods paper with medRxiv reference.  No changes to code.
  • Loading branch information
BIVectors committed May 25, 2023
1 parent b6963e4 commit 4185c1f
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 9 deletions.
24 changes: 20 additions & 4 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,26 @@ authors:
orcid: 'https://orcid.org/0000-0001-5560-5638'
identifiers:
- type: doi
value: 10.5281/zendo.7950584
description: BRAVEHEART v1.0.0
value: 10.1101/2023.05.17.23290060
description: Preprint on medRxiv
repository-code: 'https://github.com/BIVectors/BRAVEHEART'
license: GPL-3.0
commit: 4f3dd0d
version: 1.0.0
date-released: '2023-05-19'
date-released: '2023-05-24'

preferred-citation:
type: article
authors:
- given-names: Hans Fredrich
family-names: Stabenau
affiliation: Beth Israel Deaconess Medical Center
orcid: 'https://orcid.org/0000-0001-6315-7601'
- given-names: Jonathan W.
family-names: Waks
affiliation: Beth Israel Deaconess Medical Center
orcid: 'https://orcid.org/0000-0001-5560-5638'
doi: "10.1101/2023.05.17.23290060"
journal: "medRxiv"
title: "BRAVEHEART: Open-source software for automated electrocardiographic and vectorcardiographic analysis"
month: 5
year: 2023
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# BRAVEHEART: Open-Source Software for Automated Electrocardiographic and Vectorcardiographic Analysis
[![badge](https://badgen.net/badge/MATLAB/R2022a/?color=green)](https://www.mathworks.com/products/matlab.html) [![badge](https://img.shields.io/github/v/release/BIVectors/BRAVEHEART?label=Latest%20Release)](https://github.com/BIVectors/BRAVEHEART/releases) [![badge](https://badgen.net/badge/icon/Windows%20.exe?icon=windows&label)](https://github.com/BIVectors/BRAVEHEART/releases) [![badge](https://badgen.net/badge/icon/Mac%20.app?icon=apple&label)](https://github.com/BIVectors/BRAVEHEART/releases) ![badge](https://badgen.net/badge/License/GPL-3.0/?color=red)
![badge](https://github.com/BIVectors/BRAVEHEART/actions/workflows/testing.yml/badge.svg)
[![badge](https://badgen.net/badge/MATLAB/R2022a/?color=green)](https://www.mathworks.com/products/matlab.html) ![badge](https://badgen.net/badge/License/GPL-3.0/?color=red)
![badge](https://github.com/BIVectors/BRAVEHEART/actions/workflows/testing.yml/badge.svg)
[![badge](https://img.shields.io/github/v/release/BIVectors/BRAVEHEART?label=Latest%20Release)](https://github.com/BIVectors/BRAVEHEART/releases) ![badge](https://img.shields.io/github/repo-size/BIVectors/BRAVEHEART?label=Repo%20Size) ![badge](https://img.shields.io/github/directory-file-count/BIVectors/BRAVEHEART?label=File%20Count) ![badge](https://img.shields.io/github/languages/code-size/BIVectors/BRAVEHEART?label=Code%20Size) [![badge](https://badgen.net/badge/icon/Windows%20.exe?icon=windows&label)](https://github.com/BIVectors/BRAVEHEART/releases) [![badge](https://badgen.net/badge/icon/Mac%20.app?icon=apple&label)](https://github.com/BIVectors/BRAVEHEART/releases)

**Hans Fredrich Stabenau, MD, PhD & Jonathan W. Waks, MD
Harvard-Thorndike Electrophysiology Institute, Department of Cardiovascular Medicine,
Expand Down Expand Up @@ -29,13 +30,13 @@ All rights reserved.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/ or the [LICENSE](https://github.com/BIVectors/BRAVEHEART/blob/main/LICENSE) file included in this repository.

## Installation & User Guide/Software Methods
![badge](https://img.shields.io/github/repo-size/BIVectors/BRAVEHEART?label=Repo%20Size) ![badge](https://img.shields.io/github/directory-file-count/BIVectors/BRAVEHEART?label=File%20Count) ![badge](https://img.shields.io/github/languages/code-size/BIVectors/BRAVEHEART?label=Code%20Size) ![badge](https://img.shields.io/tokei/lines/github/BIVectors/BRAVEHEART?color=138dca&label=Total%20Lines)
A detailed user guide that covers installation and use of the software, including a quick start guide and examples of ECG/VCG processing, is available in the file [braveheart_userguide.pdf](https://github.com/BIVectors/BRAVEHEART/blob/main/braveheart_userguide.pdf).

A pre-print of a manuscript despribing the software methods in detail is available in the file [braveheart_methods.pdf](https://github.com/BIVectors/BRAVEHEART/blob/main/braveheart_methods.pdf). This manuscript will be available shortly as a [pre-print on medRxiv.org](https://www.medrxiv.org/).
A pre-print of a manuscript describing the software methods in detail is available in the file [braveheart_methods.pdf](https://github.com/BIVectors/BRAVEHEART/blob/main/braveheart_methods.pdf) and as a [preprint on medRxiv.org](https://doi.org/10.1101/2023.05.17.23290060).

## How to Cite Use of BRAVEHEART
Please include the link to this GitHub repository and cite our [preprint on medRxiv.org](https://www.medrxiv.org/).
[![badge](https://badgen.net/badge/medRxiv/2023.05.17.23290060/0E4C92)](https://doi.org/10.1101/2023.05.17.23290060)
Please include the link to this GitHub repository and cite our [preprint on medRxiv.org](https://doi.org/10.1101/2023.05.17.23290060). The upper right section of this repository has a [citation file](https://github.com/BIVectors/BRAVEHEART/blob/main/CITATION.cff) that will provide the appropriate references.

## Publications
The software has been used for ECG/VCG analysis in the following publications:
Expand Down
Binary file modified braveheart_methods.pdf
Binary file not shown.
Binary file modified braveheart_userguide.pdf
Binary file not shown.

0 comments on commit 4185c1f

Please sign in to comment.