Package: pkgmaker 0.32.10

Renaud Gaujoux

pkgmaker: Development Utilities for R Packages

Provides some low-level utilities to use for package development. It currently provides managers for multiple package specific options and registries, vignette, unit test and bibtex related utilities. It serves as a base package for packages like 'NMF', 'RcppOctave', 'doRNG', and as an incubator package for other general purposes utilities, that will eventually be packaged separately. It is still under heavy development and changes in the interface(s) are more than likely to happen.

Authors:Renaud Gaujoux [aut, cre]

pkgmaker_0.32.10.tar.gz
pkgmaker_0.32.10.zip(r-4.5)pkgmaker_0.32.10.zip(r-4.4)pkgmaker_0.32.10.zip(r-4.3)
pkgmaker_0.32.10.tgz(r-4.4-any)pkgmaker_0.32.10.tgz(r-4.3-any)
pkgmaker_0.32.10.tar.gz(r-4.5-noble)pkgmaker_0.32.10.tar.gz(r-4.4-noble)
pkgmaker_0.32.10.tgz(r-4.4-emscripten)pkgmaker_0.32.10.tgz(r-4.3-emscripten)
pkgmaker.pdf |pkgmaker.html✨
pkgmaker/json (API)

# Install 'pkgmaker' in R:
install.packages('pkgmaker', repos = c('https://renozao.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/renozao/pkgmaker/issues

On CRAN:

186 exports 8 stars 1.49 score 14 dependencies 92 scripts 1.7k downloads

Last updated 1 years agofrom:2934a52d38. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 25 2024
R-4.5-winNOTEAug 25 2024
R-4.5-linuxNOTEAug 25 2024
R-4.4-winNOTEAug 25 2024
R-4.4-macNOTEAug 25 2024
R-4.3-winOKAug 25 2024
R-4.3-macOKAug 25 2024

Exports:.silenceFadd_libaddnamesaddNamespaceExportallFormalsalphacolas_packageas.package_optionsas.rnwaskUserattr_modeattr_mode<-cgetAnywherecharmapcheckPlotcheckWarningcitecmdcompactVignettescompile_srcCRANdigest_functionexitCheckexpand_dotsexpand_listExposeAttributeextractLocalFunfactor2characterfile_extensionfind_devpackagegetBiocMirrorgetBiocReposgetLoadingNamespacegfilehasArg2hasEnvarhasNameshasPackageRegistryhook_backspacehook_togglehook_tryinstall.extrapackagesinstall.extrasinSweaveirequireis_NAis_option_symlinkis.diris.fileis.verboseisCHECKisCRAN_timingisCRANcheckisDevNamespaceisIntegerisLoadingNamespaceisManualVignetteisNamespaceLoaded2isNumberisPackageInstalledisRealisStringiterCountknit_exlatex_bibliographylatex_preambleldatalibnamelibrary_projectlist.datalist.libslistPackageOptionslmessageload_all_fileload_projectlog_appendlsilentlverbosemake_vignette_auxfilesmakeFakeVignettemakeUnitVignettemessagefmfrowmkoptionsmrequirenew2ns_getoneoffVariableonLoadonUnloadoption_symlinkoption_symlink_targetorderVersionpackage_bibliographypackageDatapackageEnvpackageExtrapackageExtraHandlerpackageExtraRunnerpackageOptionspackagePathpackageReferencepackageReferenceFilepackageRegistriespackageRegistrypackageTestEnvparsePackageCitationpkgreg_fetchpkgreg_removepostponeActionqlibraryqrequirequickinstallR.CMDR.execR.SHLIBRdSection2latexread.yaml_sectionregfetchrender_notesreorder_columnsrequire.quietrequirePackagerequireRUnitrnwrnwChildrenrnwCompilerrnwDriverrnwIncludesrnwWrapperrunPostponedActionrunVignetteRversionsetBiocMirrorsetCRANMirrorsetPackageExtrasetPackageExtraHandlersetPackageRegistrysetPackageRegistryEntrysetupPackageOptionssimpleRegistrysortVersionsource_filesstr_bsstr_classstr_descstr_diffstr_dimstr_funstr_hashstr_md5sumstr_nsstr_outstr_pkgsVariablesys.function_digestsys.function_framesys.function_nframeSys.getenv_valuesys.source_filetestRversiontopnstopns_nameunit.testunlist_unlist_with_sepuserDatauserIsusing_collateusing_dirusing_envusing_envvarusing_libusing_libpathsusing_localeusing_optionsusing_parusing_pathutestutestFrameworkutestPathvignetteMakefilevmessagewinbuildwnotewrite.pkgbibwriteUnitVignette

Dependencies:assertthatclicodetoolsdigestgluelifecyclemagrittrregistryrlangstringistringrvctrswithrxtable

Readme and manuals

Help Manual

Help pageTopics
Silencing Functions.silenceF
Adding Package Librariesadd_lib
Generating Namesaddnames addnames.array addnames.default addnames.matrix addnames.vector
Enhancing RUnit LoggeraddToLogger
Colour utilitiesalphacol
User QueriesaskUser
Bibtex Utilitiesbibtex packageReferenceFile package_bibliography
Get AnywherecgetAnywhere
Substituting Strings Against a Mapping Tablecharmap
Extra Check Functions for RUnitcheckWarning
Citing Package Referencescitecmd
Compile Source Files from a Development Packagecompile_src
Main CRAN Mirror URLCRAN
Compute Function Digest Hashdigest_function
Exit Error ChecksexitCheck
Expanding Listsexpand_dots expand_list
Exposing Object Attributesattr_mode attr_mode<- ExposeAttribute
Extracting Local Function DefinitionallFormals extractLocalFun
Converting Factors to Character Vectorsfactor2character
Extract File Extensionfile_extension
Find Path to Development Package Root Directoryfind_devpackage
Namespace Development FunctionsaddNamespaceExport getLoadingNamespace isDevNamespace isLoadingNamespace isNamespaceLoaded2 ns_get
Open a File Graphic Devicegfile
Utility Functions for Graphicsgraphics-utils mfrow
Checking for Missing ArgumentshasArg2
Check Environment VariableshasEnvar
Identifying Sweave RuninSweave
Require a Package with User Interactionirequire
Testing Object TypehasNames is.dir is.file isFALSE isInteger isNumber isReal isString is_NA is_something
Package Check UtilsisCHECK isCRANcheck isCRAN_timing
Simple Text Iteration CounteriterCount
Knitr Extensionshook_backspace hook_toggle hook_try knit_ex
LaTeX Utilities for Vignetteslatex_bibliography latex_preamble
List Package Data Objectslist.data
Library Files Utilitieslibname list.libs
Generate a Loading Script for Development Packagesload_all_file
Load Development Packagelibrary_project load_project
Logging Featureis.verbose lmessage log_append lsilent lverbose vmessage
Generate RMarkdown Vignette Axiliary Filesmake_vignette_auxfiles
Generate a Fake VignettemakeFakeVignette
Make Vignette for Unit TestsmakeUnitVignette
General Log Formatingmessagef wnote
Quick Option-like Feature.options mkoptions
Alternative S4 Constructornew2
One-off Global VariablesoneoffVariable
Default Load/Unload FunctionsonLoad onUnload
'option_symlink' creates a symbolic link to option 'x'.as.package_options is_option_symlink listPackageOptions option_symlink option_symlink_target packageOptions [[.package_options
Ordering Version NumbersorderVersion sortVersion
Loading Package Dataldata packageData
Package Development Utilitiesas_package isPackageInstalled packageEnv packageName packagePath str_ns topns topns_name
Package ReferencespackageReference
Package RegistryhasPackageRegistry packageRegistries packageRegistry setPackageRegistry setPackageRegistryEntry
Returns the package internal environment where unit tests are stored.packageTestEnv
Formatting Package Citations in Sweave/knitr DocumentsparsePackageCitation
Deprecated Functions in pkgmakerpkgmaker-deprecated requirePackage
Postponing ActionspostponeAction runPostponedAction
Quick Installation of a Source Packagequickinstall
Executing R CommandsR.CMD R.exec R.SHLIB
Format Rd Sections into LatTeXRdSection2latex
Reads YAML Options Embbeded into a Fileread.yaml_section
Finds an entry in a registry.pkgreg_fetch pkgreg_remove regfetch
Renders rmarkdown Documents Using User Default Optionsrender_notes
Reordering Columnsreorder_columns
Loading Packagesmrequire qlibrary qrequire require.quiet
Load RUnit Compatible PackagerequireRUnit
Utilities for Vignettesas.rnw compactVignettes isManualVignette rnw rnwChildren rnwCompiler rnwDriver rnwIncludes rnwWrapper vignetteMakefile
Compile a Vignette ObjectrunVignette
Complete R versionRversion
Setting Mirrors and RepositoriesgetBiocMirror getBiocRepos setBiocMirror setCRANMirror
Automatic S4 Class for Registry EntriessetClassRegistry
Install/Run Extra Things After Standard Package Installationinstall.extrapackages install.extras packageExtra packageExtraHandler packageExtraRunner setPackageExtra setPackageExtraHandler
Package Specific OptionssetupPackageOptions
Simple Package RegistrysimpleRegistry
Source Multiple Filessource_files
Finding Differences Between Stringsstr_diff
Formatting Utilitiesstr_bs str_class str_desc str_dim str_fun str_hash str_md5sum str_out str_pkg
Global Static VariablesVariable
System Call Stack Utilitiessys.function_digest sys.function_frame sys.function_nframe sys.source_file sys_call_stack
System Environment VariablesSys.getenv_value
Testing R VersiontestRversion
Embedded Unit Testsunit.test
Flatten a List Conserving Namesunlist_
Flattens All List Levels Using Separated Namesunlist_with_sep
User Data Directory 'userData' returns the path to a local directory/file where package-related user data can be stored. Note that a base directory is *always* created if necessary (see details).userData
Checking R UseruserIs
Execute code in temporarily altered environment.using_collate using_dir using_env using_envvar using_lib using_libpaths using_locale using_options using_par using_path using_something
Running Unit Testsutest utest,character-method utest,function-method utest,RUnitTestSuite-method
Inferring Unit Test FrameworkutestFramework
Unit Tests Result DirectoryutestPath
Build a Windows Binary Packagewinbuild
Defunct Functions in pkgmakerpkgmaker-defunct write.bib
Generate a Bibtex File from Package Citationswrite.pkgbib
Writes Unit Tests VignettewriteUnitVignette