Diff of /README.md [000000] .. [fb0f7e]

Switch to unified view

a b/README.md
1
[![R-CMD-check](https://github.com/resplab/PLCOm2012/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/resplab/PLCOm2012/actions/workflows/R-CMD-check.yaml)
2
[![test-coverage](https://github.com/resplab/PLCOm2012/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/resplab/PLCOm2012/actions/workflows/test-coverage.yaml)
3
[![codecov](https://codecov.io/gh/resplab/PLCOm2012/branch/main/graph/badge.svg?token=H9S9DM629T)](https://codecov.io/gh/resplab/PLCOm2012)
4
<!-- README.md is generated from README.Rmd. Please edit that file -->
5
6
# PLCOm2012
7
8
<!-- badges: start -->
9
10
<!-- badges: end -->
11
12
The goal of PLCOm2012 is to predict 6-year probability of lung cancer in an individual person.
13
14
## Installation
15
16
The development version from [GitHub](https://github.com/) with:
17
18
``` r
19
# install.packages("devtools")
20
devtools::install_github("resplab/PLCOm2012")
21
```
22
23
## Example
24
25
This is a basic example which shows the the 6-year probability of lung cancer in an individual person. The example is an individual who is 62 years old, white, had some college (level 4) education, with body-mass index 27, no chronic obstructive pulmonary disease, no personal history of cancer, no family history of lung cancer, former smoker, smokes 80 cigarettes per day, smokes for 27 years and quits smoking for 10 years. He/she would have 1.75% probability of getting lung cancer over the next 6 years.
26
27
``` r
28
library(PLCOm2012)
29
plcom2012(age=62, race='White', education=4, bmi=27, copd=0, 
30
          cancer_hist=0, family_hist_lung_cancer=0, smoking_status=0, 
31
          smoking_intensity=80, duration_smoking=27, smoking_quit_time=10)
32
 $prob
33
[1] 0.01750922
34
```