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

Update README.md #125

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# maicplus
open source R package for MAIC
## maicplus

`maicplus` is an open-source R package that facilitates performing Matching Adjusted Indirect Comparison (MAIC) analysis. This package is designed to handle endpoints of interest that are either time-to-event (e.g., overall survival) or binary (e.g., objective tumor response).

## Installation

You can install the development version of `maicplus` from GitHub with:

```R
# install.packages("devtools")
devtools::install_github("hta-pharma/maicplus")
```

## Overview
The maicplus package provides tools to perform MAIC analysis. MAIC is a method used to adjust for differences in baseline characteristics between treatment groups in indirect comparisons, typically where patient-level data are available for one treatment but only aggregate-level data are available for the comparator treatment. This package specifically supports endpoints that are time-to-event or binary.

## Features
* Perform MAIC analysis for time-to-event endpoints (e.g., overall survival).
* Perform MAIC analysis for binary endpoints (e.g., objective tumor response).
* User-friendly functions to facilitate the analysis process.
* Comprehensive documentation and examples to guide users through the analysis.

## Usage
* Time-to-Event Endpoint Example (use code for example)
* Binary Endpoint Example (use code for example)

## Documentation
Detailed documentation for each function is available within the package. You can access the documentation using the ? operator in R. Additionally, comprehensive vignettes are provided to help you get started and understand the application of the package:
```R
vignette("maicplus").
```

## License
This project is licensed under the MIT License - see the (put the LICENSE here) file for details.

## Contact
If you have any questions or feedback, please get in touch with us at [email@example.com].
Loading