9 Documenting the package and adding README and pkgdown website
We finish by running commands that will document the package.
## ℹ Updating cssr documentation
## Writing 'NAMESPACE'
## ℹ Loading cssr
## Writing 'NAMESPACE'
## Writing 'checkB.Rd'
## Writing 'checkClusters.Rd'
## Writing 'checkCssClustersInput.Rd'
## Writing 'checkCssInputs.Rd'
## Writing 'checkCssLassoInputs.Rd'
## Writing 'checkCssLoopOutput.Rd'
## Writing 'checkCutoff.Rd'
## Writing 'checkFormCssDesignInputs.Rd'
## Writing 'checkFormatClustersInput.Rd'
## Writing 'checkGenClusteredDataInputs.Rd'
## Writing 'checkGenClusteredDataWeightedInputs.Rd'
## Writing 'checkGenClusteredDataWeightedRandomInputs.Rd'
## Writing 'checkGetClusterSelMatrixInput.Rd'
## Writing 'checkGetCssPredsInputs.Rd'
## Writing 'checkGetSelectedClustersOutput.Rd'
## Writing 'checkGetXglmnetInputs.Rd'
## Writing 'checkMaxNumClusts.Rd'
## Writing 'checkMinNumClusts.Rd'
## Writing 'checkNewXProvided.Rd'
## Writing 'checkPropFeatsRemove.Rd'
## Writing 'checkSamplingType.Rd'
## Writing 'checkSelectedClusters.Rd'
## Writing 'checkWeighting.Rd'
## Writing 'checkXInputResults.Rd'
## Writing 'checkY.Rd'
## Writing 'clusterRepLasso.Rd'
## Writing 'corFunction.Rd'
## Writing 'createSubsamples.Rd'
## Writing 'css.Rd'
## Writing 'cssLasso.Rd'
## Writing 'cssLoop.Rd'
## Writing 'cssPredict.Rd'
## Writing 'cssSelect.Rd'
## Writing 'cssr-package.Rd'
## Writing 'formCssDesign.Rd'
## Writing 'formatClusters.Rd'
## Writing 'genClusteredData.Rd'
## Writing 'genClusteredDataWeighted.Rd'
## Writing 'genClusteredDataWeightedRandom.Rd'
## Writing 'genZmuY.Rd'
## Writing 'getAllClustWeights.Rd'
## Writing 'getClustWeights.Rd'
## Writing 'getClusterSelMatrix.Rd'
## Writing 'getClusterSelsFromGlmnet.Rd'
## Writing 'getCssDesign.Rd'
## Writing 'getCssPreds.Rd'
## Writing 'getCssSelections.Rd'
## Writing 'getLassoLambda.Rd'
## Writing 'getModelSize.Rd'
## Writing 'getNoiseVar.Rd'
## Writing 'getPrototypes.Rd'
## Writing 'getSelMatrix.Rd'
## Writing 'getSelectedClusters.Rd'
## Writing 'getSelectedSets.Rd'
## Writing 'getSelectionPrototypes.Rd'
## Writing 'getSubsamps.Rd'
## Writing 'getXglmnet.Rd'
## Writing 'identifyPrototype.Rd'
## Writing 'print.cssr.Rd'
## Writing 'printCssDf.Rd'
## Writing 'processClusterLassoInputs.Rd'
## Writing 'protolasso.Rd'9.1 Add README
## ✔ Writing 'README.Rmd'.## ✔ Adding "^README\\.Rmd$" to '.Rbuildignore'.## ✔ Creating '.git/hooks/'.## ✔ Writing '.git/hooks/pre-commit'.Let’s move the two images that we refer to in the README into man/figures. This is based on the “Images and figures” section of the man page for pkgdown::build_home_index().
9.2 Add pkdgown site
## ✔ Adding "^_pkgdown\\.yml$", "^docs$", and "^pkgdown$" to '.Rbuildignore'.## ── Installing package cssr into temporary library ──────────────────────────────## ── Building pkgdown site for package cssr ──────────────────────────────────────
## Reading from: /Users/gregfaletto/Documents/GitHub/cssr-project/cssr
## Writing to: /Users/gregfaletto/Documents/GitHub/cssr-project/docs
## ── Sitrep ──────────────────────────────────────────────────────────────────────
## ✖ URLs not ok.
## In _pkgdown.yml, url is missing.
## See details in `vignette(pkgdown::metadata)`.
## ✔ Favicons ok.
## ✔ Open graph metadata ok.
## ✔ Articles metadata ok.
## ✔ Reference metadata ok.
## ── Initialising site ───────────────────────────────────────────────────────────
## ── Building home ───────────────────────────────────────────────────────────────
## ✖ Icon "fa-github" lacks an `aria-label`.
## ℹ Specify `aria-label` to make the icon accessible to screen readers.
## ℹ Learn more in `vignette(pkgdown::accessibility)`.
## This message is displayed once every 8 hours.
## Reading LICENSE.md
## Reading README.md
## Writing `404.html`
## ── Building function reference ─────────────────────────────────────────────────
## Reading man/checkB.Rd
## Reading man/checkClusters.Rd
## Reading man/checkCssClustersInput.Rd
## Reading man/checkCssInputs.Rd
## Reading man/checkCssLassoInputs.Rd
## Reading man/checkCssLoopOutput.Rd
## Reading man/checkCutoff.Rd
## Reading man/checkFormCssDesignInputs.Rd
## Reading man/checkFormatClustersInput.Rd
## Reading man/checkGenClusteredDataInputs.Rd
## Reading man/checkGenClusteredDataWeightedInputs.Rd
## Reading man/checkGenClusteredDataWeightedRandomInputs.Rd
## Reading man/checkGetClusterSelMatrixInput.Rd
## Reading man/checkGetCssPredsInputs.Rd
## Reading man/checkGetSelectedClustersOutput.Rd
## Reading man/checkGetXglmnetInputs.Rd
## Reading man/checkMaxNumClusts.Rd
## Reading man/checkMinNumClusts.Rd
## Reading man/checkNewXProvided.Rd
## Reading man/checkPropFeatsRemove.Rd
## Reading man/checkSamplingType.Rd
## Reading man/checkSelectedClusters.Rd
## Reading man/checkWeighting.Rd
## Reading man/checkXInputResults.Rd
## Reading man/checkY.Rd
## Reading man/clusterRepLasso.Rd
## Reading man/corFunction.Rd
## Reading man/createSubsamples.Rd
## Reading man/css.Rd
## Reading man/cssLasso.Rd
## Reading man/cssLoop.Rd
## Reading man/cssPredict.Rd
## Reading man/cssSelect.Rd
## Reading man/cssr-package.Rd
## Reading man/formCssDesign.Rd
## Reading man/formatClusters.Rd
## Reading man/genClusteredData.Rd
## Reading man/genClusteredDataWeighted.Rd
## Reading man/genClusteredDataWeightedRandom.Rd
## Reading man/genZmuY.Rd
## Reading man/getAllClustWeights.Rd
## Reading man/getClustWeights.Rd
## Reading man/getClusterSelMatrix.Rd
## Reading man/getClusterSelsFromGlmnet.Rd
## Reading man/getCssDesign.Rd
## Reading man/getCssPreds.Rd
## Reading man/getCssSelections.Rd
## Reading man/getLassoLambda.Rd
## Reading man/getModelSize.Rd
## Reading man/getNoiseVar.Rd
## Reading man/getPrototypes.Rd
## Reading man/getSelMatrix.Rd
## Reading man/getSelectedClusters.Rd
## Reading man/getSelectedSets.Rd
## Reading man/getSelectionPrototypes.Rd
## Reading man/getSubsamps.Rd
## Reading man/getXglmnet.Rd
## Reading man/identifyPrototype.Rd
## Reading man/print.cssr.Rd
## Reading man/printCssDf.Rd
## Reading man/processClusterLassoInputs.Rd
## Reading man/protolasso.Rd
## ── Building sitemap ────────────────────────────────────────────────────────────
## ── Building docs for llms ──────────────────────────────────────────────────────
## ── Building search index ───────────────────────────────────────────────────────
## ── Checking for problems ───────────────────────────────────────────────────────
## ── Finished building pkgdown site for package cssr ─────────────────────────────## ── Finished building pkgdown site for package cssr ─────────────────────────────