Repository hySpc.skeleton
is a package template ("skeleton") for r-hyperspec
family packages.
When creating a new package (repository):
- replace words
SKELETON
andhySpc.skeleton
with the new package name in:-
DESCRIPTION
-
NEWS.md
-
README.md
-
LICENSE
-
tests/testthat.R
-
tests/testthat/test_attached.R
- other files
-
- update
DESCRIPTION
:- title
- description
- the list of authors and contributors
- license
- other fields
- update licensing information in
-
DESCRIPTION
-
LICENSE
-
README.md
- elswhere
-
- update
README
:- update badges
- update installation instructions (e.g., instead of
devtools::install(build_vignettes = TRUE)
the following code might be more appropriate if no vignettes are includeddevtools::install()
) - update other information, if needed.
- create issue labels:
- apply github labels (in
github-helpers/
), - delete
github-helpers/
- apply github labels (in
- Code & Vignettes:
- Be sure to review
CONTRIBUTING.md
which describes the standard operating procedures for ther-hyperspec
project. - Copy the code needed for this new package from the original
hyperSpec
files. Leave the old code untouched for now, ashyperSpec
has to continue to operate. - Update the code and write new code as needed.
- Update unit tests as needed.
- Update examples as needed.
- Build and check locally. Chase out the demons.
- Create a new vignette for this package, starting from the relevant vignette in original
hyperSpec
. - Build and check locally again, fixing any remaining problems.
- Create a pull request as described in
CONTRIBUTING.md
. - Rinse and repeat to reach perfection!
- Be sure to review
- update this list of TODOs
- Delete this TODO section.
R package hySpc.skeleton is a member of the r-hyperspec
packages family, which ...
WRITE THE PURPOSE OF THIS PACKAGE
There are two versions of hySpc.skeleton online documentation:
a. for the released version of package,
b. for the development version of package.
The documentation of the other r-hyperspec
family packages can be found at r-hyperspec.github.io.
You can install the released version of hySpc.skeleton from CRAN with:
install.packages("hySpc.skeleton")
You can install the development version of the package from GitHub:
if (!require(remotes)) {install.packages("remotes")}
remotes::install_github("r-hyperspec/hySpc.skeleton")
NOTE 1: Usually, "Windows" users need to download, install and properly configure Rtools (see these instructions) to make the code above work.
NOTE 2: This method will not install package's documentation (help pages and vignettes) into your computer. So you can either use the online documentation or build the package from source (see the next section).
-
From the hySpc.skeleton's GitHub repository:
-
Open the downloaded directory in RStudio (preferably, as an RStudio project).
- The code below works correctly only if your current working directory coincides with the root of the repository, i.e., if it is in the directory that contains file
README.md
. - If you open RStudio project correctly (e.g., by clicking
project.Rproj
icon in the directory), then the working directory is set correctly by default.
- The code below works correctly only if your current working directory coincides with the root of the repository, i.e., if it is in the directory that contains file
-
In RStudio 'Console' window, run the code (provided below) to: a. Install packages remotes and devtools. b. Install hySpc.skeleton's dependencies. c. Create hySpc.skeleton's documentation. d. Install package hySpc.skeleton.
# Do not abort installation even if some packages are not available
Sys.setenv(R_REMOTES_NO_ERRORS_FROM_WARNINGS = "true")
# Install packages remotes and devtools
install.packages(c("remotes", "devtools"))
# Install hySpc.skeleton's dependencies
remotes::install_deps(dependencies = TRUE)
# Create hySpc.skeleton's documentation
devtools::document()
# Install package hySpc.skeleton
devtools::install(build_vignettes = TRUE)
NOTE 1: Usually, "Windows" users need to download, install and properly configure Rtools (see these instructions) to make the code above work.