Adding README, cran-comments, updating description

.Rbuildignore

@@ -8,3 +8,4 @@
 ^\.github$
 ^doc$
 ^Meta$
+^cran-comments\.md$

DESCRIPTION

@@ -1,14 +1,14 @@
 Package: gFormulaMI
-Title: G-formula for causal inference via multiple imputation
+Title: G-formula for Causal Inference via Multiple Imputation
 Version: 0.0.1
 Authors@R: 
     c(person("Jonathan", "Bartlett", , "jonathan.bartlett1@lshtm.ac.uk", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-7117-0195")),
            person("Camila", "Olarte Parra", email = "camila.olarte-parra@lshtm.ac.uk", role = "ctb",
            comment = c(ORCID = "0000-0003-0263-4392")))
-Description: gFormulaMI implements the G-formula method for causal inference
+Description: This package implements the G-formula method for causal inference
   using Bayesian multiple imputation methods. It creates multiple synthetic imputed
-  datasets under treatment regimes of interest. These can then be analysed
+  datasets under treatment regimes of interest using the mice package. These can then be analysed
   using rules developed for analysing multiple synthetic datasets.
 License: GPL (>= 3)
 Encoding: UTF-8

README.md

@@ -0,0 +1,19 @@
+
+# gFormulaMI
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+gFormulaMI is an R package that implements the G-formula method for causal inference with
+time-varying treatments and confounders using multiple imputation methods. For more information,
+including examples, see the gFormulaMI [package website](https://jwb133.github.io/gFormulaMI/).
+
+## Installation
+
+You can install the development version of gFormulaMI from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("jwb133/gFormulaMI")
+```
+

cran-comments.md

@@ -0,0 +1,5 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.