update docs

elbersb · Jun 15, 2018 · 8ce5093 · 8ce5093
1 parent cb5fbbc
commit 8ce5093
Show file tree

Hide file tree

Showing 13 changed files with 21 additions and 83 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -8,3 +8,4 @@
 ^codecov\.yml$
 ^\.travis\.yml$
 ^render_README\.R$
+^docs$
diff --git a/R/data.R b/R/data.R
@@ -3,7 +3,7 @@
 #' Fake dataset used for examples. Loosely based on data provided by
 #' the National Center for Education Statistics, Common Core of Data,
 #' with information on U.S. primary schools in three U.S. states.
-#' The original data can be downloaded free of charge at https://nces.ed.gov/ccd/.
+#' The original data can be downloaded at \url{https://nces.ed.gov/ccd/}.
 #'
 #' @format A data frame with 8,142 rows and 5 variables:
 #' \describe{
@@ -20,7 +20,7 @@
 #' Fake dataset used for examples. Loosely based on data provided by
 #' the National Center for Education Statistics, Common Core of Data,
 #' with information on U.S. primary schools in three U.S. states.
-#' The original data can be downloaded free of charge at https://nces.ed.gov/ccd/.
+#' The original data can be downloaded at \url{https://nces.ed.gov/ccd/}.
 #'
 #' @format A data frame with 8,013 rows and 5 variables:
 #' \describe{

diff --git a/R/segregation.R b/R/segregation.R
@@ -5,22 +5,7 @@
 #' Provides tools to decompose the measures by groups and units, and by within
 #' and between terms. Includes standard error estimation by bootstrapping.
 #'
-#' @section Methods:
-#'
-#' \itemize{
-#'  \item{}{\code{\link{mutual_total}} Computes M and H.}
-#'  \item{}{\code{\link{mutual_within}} Computes detailed within-category segregation.}
-#'  \item{}{\code{\link{mutual_local}} Computes local segregation based on M.}
-#'  \item{}{\code{\link{mutual_difference}} Decomposes difference between two M indices.}
-#'  \item{}{\code{\link{entropy}} Calculates the entropy of a distribution.}
-#'  \item{}{\code{\link{ipf}} Uses iterative proportional fitting to adjust
-#'    the marginal distributions in one dataset to those of another dataset.}
-#' }
-#' @section Data:
-#'
-#' \itemize{
-#'  \item{}{\code{\link{schools00}} and \code{\link{schools05}} Example datasets.}
-#' }
+#' @seealso \url{https://elbersb.de/segregation}
 #'
 #' @docType package
 #' @name segregation

diff --git a/README.Rmd b/README.Rmd
@@ -79,6 +79,8 @@ mutual_difference(schools00, schools05, group = "race", unit = "school",
                   weight = "n", method = "ipf")
 ```
 
+Find more information in the [documentation](https://elbersb.de/segregation).
+
 ## How to install
 
 To install the package from CRAN, use
@@ -93,12 +95,6 @@ To install the development version, use
 devtools::install_github("elbersb/segregation") 
 ```
 
-To access the documentation ([PDF](https://cran.r-project.org/web/packages/segregation/segregation.pdf)), type
-
-```{r eval=FALSE}
-?segregation
-```
-
 ## Papers using the Mutual information index
 
 (list incomplete)

diff --git a/README.md b/README.md
@@ -107,6 +107,9 @@ mutual_difference(schools00, schools05, group = "race", unit = "school",
 #>      structural  0.00318
 ```
 
+Find more information in the
+[documentation](https://elbersb.de/segregation).
+
 ## How to install
 
 To install the package from CRAN, use
@@ -121,14 +124,6 @@ To install the development version, use
 devtools::install_github("elbersb/segregation") 
 ```
 
-To access the documentation
-([PDF](https://cran.r-project.org/web/packages/segregation/segregation.pdf)),
-type
-
-``` r
-?segregation
-```
-
 ## Papers using the Mutual information index
 
 (list incomplete)

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/reference/schools00.html b/docs/reference/schools00.html
diff --git a/docs/reference/schools05.html b/docs/reference/schools05.html
diff --git a/docs/reference/segregation.html b/docs/reference/segregation.html
diff --git a/man/schools00.Rd b/man/schools00.Rd
diff --git a/man/schools05.Rd b/man/schools05.Rd
diff --git a/man/segregation.Rd b/man/segregation.Rd
diff --git a/render_README.R b/render_README.R
@@ -8,4 +8,3 @@ rmarkdown::render("README.Rmd",
                       html_preview = FALSE))
 
 pkgdown::build_site()
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,4 +8,3 @@ rmarkdown::render("README.Rmd",
		html_preview = FALSE))

		pkgdown::build_site()