pxmake 0.18.0
New features
px_data() has a new argument, labels,
which makes the function return the data table with VALUES instead of
CODES. (#419)
Breaking changes
- ELIMINATION is changed from language dependent to not language
dependent, and instead of adding ELIMINATION as values, it is done with
codes. (#406)
Bug fixes and minor
improvements
- Bugfix when saving as R scripts. (#410)
- Elimination values and order are preserved when changing data table.
(#418, #420)
pxmake 0.17.0
Bug fixes and minor
improvements
- Remove import of ‘pillar’ package. (#387)
- Fix various issues with CONTVARIABLE. (#364 #386)
px_data() updates metadata to match new data frame.
(#385 #396 #399)
- When adding more languages dummy values are added as VALUES instead
of blanks.
- Throw error when using
px_save() on a px object that
contains duplicates in the data table. (#402)
- Don’t save NA values in aggregations files. (#401)
Breaking changes
- Create aggregations from texts in section [Aggtext]. (#389)
pxmake 0.16.0
New features
- When creating px object from data frame the ordering in cells1 is
determined based on the type in the data frame.
Breaking changes
- Require R version >= 4.1. (#376)
- Store all non-figures variables in data table as character instead
of as factors. (#375)
Bug fixes and minor
improvements
- Make tests an examples ‘fail gracefully’ if URL can’t be reached, to
comply with CRAN policies. (#379)
pxmake 0.15.1
Bug fixes and minor
improvements
- Remove invalid URL from
px_variable_label()
documentation.
pxmake 0.15.0
New features
- Variable order is preserved as it appears in the data set.
(#345)
px() supports URLs as input. (#353)
px_save() can save px object as an R script that, when
run, regenerates the px object. The implementation is not fully
reliable; in some cases, running the generated R script produces a
slightly different px object. (#350)
Bug fixes and minor
improvements
- Bugfix:
px_micro() sometimes ordered variable
references incorrectly in CELLNOTES. (#348)
- Removed
dontrun example from
px_classification() by updating package files. (#346)
- Use main language VALUES as CODES in PX-files without
CODES. (#361)
pxmake 0.14.2
- Add CRAN note explaning why /dontrun{} is used.
pxmake 0.14.1
Bug fixes and minor
improvements
- Fix one CRAN submission related issue, and add a note about
another.
pxmake 0.14.0
New features
- Prepare for CRAN submission. (#330)
- Add
validate = option to all modifying functions to
enable turning off validation. (#332)
- Add functions
px_classification() and
px_classification_save() to create and save classifications
(value sets and aggregations). (#327)
Bug fixes and minor
improvements
px_elimination(), px_map(), and
px_domain() now only sets value for STUB/HEADING variables
if value is character. (#325)
- Optimize
px_micro() by only setting stub once, instead
of for all files.
- Add
na_to_star option to px_cellnote() and
px_cellnotex(). (#335)
- Support PX-files with cell values that contain closing parentheses.
(#337)
- Avoid all R CMD Check notes, warning and errors.
- Add CRAN installation instruction.
- Use name ‘PX-files’ consistently.
- Update package title and description.
- Add @examples
and @return for all
exported functions.
- Reduce size of large files.
pxmake 0.12.1
New features
px() and px_save() can write and read to
and from .parquet files.
- Change default value for all mandatory keywords to be descriptive
rather than empty string ““. This was done because PxWin does not allow
empty strings in mandatory keywords. (#320)
- Improve implementation and fix bugs in
px_cellnote()
and px_cellnotex(). (#289)
Bug fixes and minor
improvements
- Keyword UNITS is now placed after CONTVARIABLE and VALUES in the
PX-file. (#308)
- Add default values for mandatory keywords in all languages.
(#219)
- Bugfix
px_language() stops removing previously defined
languages. (#297)
- Change sorting order of PX-file, so variables within keywords are in
stub/heading order instead of alphabetic. (#264)
- Throw error if any value contains quotation marks (“). (#238)
- Allow minimal px object to be created even if no input is provided.
(#234)
- Bugfix
px_micro() used undefined function. (#290)
- Changing figures removes previous figures variable form cells1 and
cells2. (#300)
- Add validation check that CONTVARIABLE and TIMEVAL has to be STUB or
HEADING variables. (#305)
- Add pxmake logo.
- Keyword MAP is now stored in variables2 instead of table2.
(#295)
pxmake 0.12.0
Breaking changes
- Change argument ‘variable’ and ‘variables’ to ‘value’ in
px_stub(), px_heading(),
px_figures(), px_timeval(),
px_add_totals(), to align with all other modifying
functions. (#296)
New features
- Add modifying functions:
px_values(),
px_variable_label(), px_data(),
px_source(). (#291)
- Add pkgdown version of documentation on:
https://statisticsgreenland.github.io/pxmake/
- Add example data sets
population_gl and
greenlanders. (#282)
px_micro() support multilingual
keyword_values arguments. (#306)
- Add example section to most help pages.
Bug fixes and minor
improvements
- Update
px_micro() documentation.
- Bugfix:
px_add_totals() now uses default value ‘Total’
if x$variables2$elimination is NA. (#284)
- Add
na.rm argument to
px_add_totalts().
px() can now take an Excel workbook without a ‘Data’
sheet, without requiring that argument ‘data’ is supplied.
- Remove unused functions.
- Add three vigenttes. (#277, #278, #280)
- Increase test coverage.
- Move px keywords to internal data set.
- Add link to Statstics Sweden’s documentation in help page for all px
keywords.
- Add Statistics Greenland vignette.
pxmake 0.11.0
This release contains a lot of breaking changes. This was
done because a few functions had name clashes with popular packages. The
prefix ‘px_’ was added to almost all functions to avoid this.
Because of this massive breaking change, a few other breaking changes
were made as well, to create more intuitive naming and make the package
more consistent.
How to update
code from before version 0.11.0
- Rename functions
- Change all modifying functions by adding the prefix
px_. E.g. change stub() to
px_stub(), heading() to
px_heading(), etc.
- Change
pxsave() to px_save().
- Change
micromake() to px_micro().
- Remove functions
- These functions have been deprecated and can no longer be used:
metamake(), pxmake(),
make_template().
- px-object changes
- Change
x$codelists1 and x$codelists2 to
x$cells1 and x$cells2.
- Change
x$acrosscell to x$acrosscells.
- Change
x$variables1$type to
x$variables1$variable-type.
- Excel changes
- Change sheet ‘Codelists1’ and ‘Codelists2’ to ‘Cells1’ and
‘Cells2’.
- Change sheet ‘Acrosscell’ to ‘Acrosscells’.
- In ‘Variables1’ sheet change column ‘type’ to ‘variable-type’ .
- To set a variable as TIMEVAL add a new column ‘timeval’ in
‘Variables1’ and set it to ‘TRUE’. TIMEVAL can no longer be set with
type="TIME" in Variables1.
Breaking changes
- Rename ‘codelists’ to ‘cells’ in px-object and Excel workbooks.
(#256)
- Deprecate ‘metamake’, ‘pxmake’ and ‘make_template’. (#198)
- Change name of all modifying functions by adding the prefix ‘px_’.
(#254)
- Rename ‘acrosscell’ to ‘acrosscells’. (#271)
- Rename
type to variable-type in
variables1. (#261)
- Move TIMEVAL to its own column in variables1, instead of having it
as part of
variable-type. (#265)
- Rename ‘pxsave’ to ‘px_save’. (#273)
- Rename ‘figures’ to ‘px_figures’, ‘order’ to ‘px_order’,
‘add_totals’ to ‘px_add_totals’. (#274)
- Rename ‘micromake’ to ‘px_mircro’.
New features
- Add modifying functions:
map(),
baseperiod(), domain(),
elimination(), descriptiondefault(),
order(), precision(), cellnote(),
cellnotex(), cfprices(),
stockfa(), variable_type(),
contvariable(). (#246) (#125) (#223)
micromake() use furrr package to run in parallel.
(#248)
micromake() removes headings if all figures are NA.
(#250)
Bug fixes and minor
improvements
- Fix mistake in documentation for all table2 modifying
functions.
- Avoid warning caused by helper function.
- Bugfix:
cellnote() can handle an empty data frame.
pxmake 0.10.1
New features
- Change all modifying functions to also be getters, so
e.g.
stub(x) returns current STUB variables.
pxsave() automatically adds values if they aren’t
defined in codelists2.
- Add argument
save_data to pxsave() to
supress saving of ‘Data’ sheet in Excel. (#204)
- Add arugment
data_path to pxsave() to save
data table as an .rds file. (#204)
- Add micromake arguments to control keywords for invidual tables.
(#239)
- Add possibility for micromake to control output filenames.
(#242)
- Add new modifying functions:
last_updated(),
next_update(), language(),
languages(), valuenote(),
valuenotex(), contents(),
description(), subject_area(),
subject_code(), title(), units(),
aggregallowed(), autopen(),
axis_version(), codepage(),
confidential(), copyright(),
showdecimals(), tableid(),
update-frequency(), contact(),
link(), note(), notex(),
infofile().
Bug fixes and minor
improvements
- Throw error if trying to remove mandatory keyword. (#208)
- Validate px after using modifying functions.
- validate_px checks that keywords in table1 and table2 are in the
right table.
- Check that arguments to micromake are valid.
- Sort data before creating codelist from data frame. (#197)
- Add priority and complexity to list of unimplemented keywords.
- Add check if keywords are in correct table.
- Remove ‘micro’ prefix from filenames created by micromake().
- Use documentation functions for table1 and table2 functions, so they
are and very easy to change.
- Add test coverage badge to README.md.
- Check that all defined variable-codes are in data.
- Add check that data columns are defined.
- In
micromake() used preserve HEADING variables, and
produces PX-files for all other variables.
- Bugfix:
heading(), stub() and
figures() no longer modify order of other variables.
(#225)
- Remove duplication in documentaiton of pivot modifying
functions.
- Bugfix:
last_updated() created wrong keyword
(#233)
- Remove ‘micro’ prefix from filenames created by micromake().
- Bugfix: wrong error message (#243)
- Bugfix:
last_updated() modified wrong table.
- Bugfix: Remove NA values when creating PX-file (#205).
- Bugfix:
px(input) can be a path to an .rds
file.
pxmake 0.10.0
New features
- The function
px() creates a px object. This is
a major change to the way package works. pxmake and
metamake are soft deprecated. Use px() and
pxsave() instead. (#197)
- To modify the px object, a number of modifying functions
have been added:
charset(), creation_date(),
decimals(), matrix(), stub(),
heading(), timeval(),
add_totals() and figures(). Many more need to
be added in the future, to cover all px keywords.
Breaking changes
- The ‘rds’ version of the PX-file is completly gone. Neither
pxmake() nor metamake() can create them.
pxmake() and metamake() can convert between Excel and PX-files, and they
return a px object invisibly. pxmake() and
metamake() will be deprecated in the future.
make_template() will be deprecated in the future -
px() automatically creates a metadata template if none is
provided.
micromake() now takes a px object as input.
add_totals() now takes a px object as input.
Bug fixes and minor
improvements
README.md has been rewritten, and includes a list of
all keywords with modifying functions. All vignettes have been
removed.
README.md is now created from README.Rmd
using knitr::knit().
pxmake 0.9.1
New features
- Add
make_template to create a minimial multilingual
metadata template. (#186)
- Add
micromake to create many small PX-files from a
large data set. See vignette(micromake). (#176)
- Support keyword VALUENOTE (#187)
Bug fixes and minor
improvements
- Add import of pipe. (Reverses commit #d59866c)
- Add vignette about creating PX-file and multilingual PX-file.
- Fix edge case in list mergeing.
- Use latin1 to default encoding, but add CODEPAGE=utf-8.
- Set maximum column width in Excel.
- Add
create_data argument to metamake that
can supress generation of data.
pxmake 0.9.0
New features
- Let
metamake accept a data frame as input and create a
minimal metadata template for the data.
Bug fixes and minor
improvements
- Handle PX-files with either zero heading variables or zero stub
variables. (#95)
- Fix edge case in list sorting caused by PX-files with no codes.
- Use values as codes if no code is given for add_totals
variable.
pxmake 0.8.1
Bug fixes and minor
improvements
- Use variable-code as variable-label if no label is given.
(#173)
- Quote values of text keywords even if their text is a number.
(#164)
pxmake 0.8.0
Breaking changes
- Split sheet ‘Table’ into two sheets by language dependency.
(#65)
- Split column ‘position’ in ‘Variables’ sheet into ‘pivot’ and
‘order’. (#159)
- Check for illegal values in columns ‘pivot’ and ‘type’ in ’Variables
sheet.
- Rename ‘variable’ and ‘long_name’ to ‘variable-code’ and
‘variable-label’. (#144)
- Add check for language-dependent mandatory variables in Excel
metadata.
New features
- Return rds object invisibly from
pxmake and
metamake. (#37)
- Support CONTVARIABLE. (#132)
- Preserve name of FIGURES variable through all data formats.
Bug fixes and minor
improvements
- Rename all internal functions from ‘source_data’ to ‘data’.
(#151)
- Print error message without the name of the function that threw the
error.
- Sort metadata before saving.
pxmake 0.7.0
New features
- Make
pxmake and metamake read and write to
.rds files.
Bug fixes and minor
improvements
- Validate arguments to
pxmake and metamake
and give helpful error messages.
- Support PX-files without LANGUAGES keyword. (#143)
- Remove dependencies between test and run them in parallel.
(#112)
- Split tests into more files to run them faster in parallel.
(#149)
- GitHub actions cancels build if a newer commit is pushed.
- Lots of documentation improvements.
pxmake 0.6.0
Breaking changes
- Rewrite
pxmake and metamake to improve
readability.
pxmake 0.5.2
Bug fixes and minor
improvements
- Remove need for awkward quoting in metadata with multiple languages.
Previously this has to be written as
en","da","kl, but can
now be en,da,kl.
- Remove VARIABLECODE for figures variables.
- Make
metamake use value as code if code is
missing.
- Ignore NAs when summing in
add_totals.
pxmake 0.5.1
New features
- Add keyword VARIABLECODE which should variable names from source
data.
Bug fixes and minor
improvements
- Remove quotes around YES in elimination.
- Make Excel table theme less dominant.
- Allow variable names to contain all characters except quotes
(“).
- Improve installation instructions.
pxmake 0.5.0
Breaking changes
- Rename ‘General’ metadata sheet to ‘Table’. (#85)
- Rename argument
pxmake(source_data_path) to
source_data (#71)
- Rename argument
metamake(out_path) to
xlsx_path. (#106)
New features
- Write and read files in encoding defined by keyword CODEPAGE. (#114,
#115)
- Break lines in PX-files with values longer than 256 characters.
(#113)
- Support other main languages than English. (#54)
- Support any language code (previously only supported: en, da, kl,
and fo). (#117)
Bug fixes and minor
improvements
- Add formatting to Excel metadata workbook created by
metamake(). (#100)
- Add argument
rds_data_path to metamake()
to save data as rds file. (#108)
- Let
pxmake() accept data frame as source data in
addition to accepting a path. (#71)
- Turn off
readLines() warning for missing EOL character.
(#113)
- Rename
.figures to figures_ in metadata
created by metamake(). (#104)
- Allow forward slashes in variables names.
- Let
metamake() support tables without time variables.
(#120)
- Use values as codes in there are no codes in metadata. (#102)
pxmake 0.4.0
New features
- Add metamake() which creates an Excel metadata workbook from a
PX-file. This is the inverse function of pxmake(). (#68)
Bug fixes and minor
improvements
- CODES added for time variables. (#91)
- Data cube is sorted correctly for data with more than one heading
variable. (#93)
- Non-figure variables are read as character. (#87, #84, #73)
- Add keywords AUTOPEN and AGGREGALLOWED
- Allow figures variable to have any name (previously only
‘values’)
pxmake 0.3.0
New features
- Time values are added correctly the PX-file.
- If no
source_data_path is given, pxmake()
looks for a ‘Data’ sheet in the metadata and uses that instead.
- New argument: add_totals. Choose variable(s) to add a total level
to.
Bug fixes and minor
improvements
- Complete data by using values both from codelist and data.
- Lot of small changes to avoid warnings when running R CMD
check.
- Add automatic testing on GitHub.
- Move helper functions to own file.
pxmake 0.2.0
New features
- Better names for sheets, variables and keywords in Excel metadata
workbook.
- Sort keywords in recommended order
Bug fixes and minor
improvements
- Add installation instruction to README.md
pxmake 0.1.0
New features
- Add support for more than one HEADING variable
Bug fixes and minor
improvements
- Allow blank fields in metadata (NA is replaced with ““)
- PxJob is run as parts of tests