Skip to content

Commit f32c758

Browse files
committed
update readme
1 parent ca65c1f commit f32c758

2 files changed

Lines changed: 14 additions & 20 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,32 @@ Converting date ranges into dating 'steps' eases the visualization of changes in
1111

1212
A rather common problem in archaeology is the fuzzyness of dates assigned to objects. If one wants to visualize overall changes in - let's say - pottery consumption, bar charts often fall short in that regard. If, e.g., the Phases a -- f are employed, then some of the objects can usually be dated to a, c, and f, as an example, but others will by classified as "a to c" or "b to c". But how can these data still be used for examining changes in a large set of objects without completely disregarding the information added by providing multiple phases for one object?
1313

14-
This package proposes a method to prepare archaeological data for the visualization using density plots. An example is shown in /vignettes/. Density plots are easy to understand and are usually aesthetically pleasing. They do omit a some information, such as individual counts, that bar histograms can communicate better. On the other hand, ranges can be incorporated into the visualization as well to regard the variety of timespans archaeological objects may be dated to.
14+
This package proposes implements the concepts of aoristic analysis to prepare archaeological data for the visualization using density plots. An example is shown in the vignettes, which can be found at
15+
16+
browseVignettes("datplot")
17+
18+
after installing the package, or on GitHub in the /vignettes/ directory. Density plots are easy to understand and are usually aesthetically pleasing. They do omit a some information, such as individual counts, that bar histograms can communicate better. On the other hand, ranges can be incorporated into the visualization as well to regard the variety of timespans archaeological objects may be dated to.
1519

1620
I imagine this to be mostly useful for surveys and other analysis aimed at the longue duree.
1721

1822
![Attic Pottery from BAPD by Date](inst/extdata/demo_readme.png "Attic Pottery from BAPD by Date")
1923

20-
Installation
21-
-------
22-
'datplot' can be installed from GitHub directly with devtools:
2324

24-
devtools::install_github("lsteinmann/datplot")
2525

2626
Recommendation
2727
-------
28-
People interested in employing this method should also consider taking a look at [ISAAKiel's package aoristAAR](https://github.com/ISAAKiel/aoristAAR/).
28+
People interested in employing this method should also consider taking a look at [ISAAKiel's package aoristAAR](https://github.com/ISAAKiel/aoristAAR/), or at [archSeries](github.com/davidcorton/archSeries), [tabula](github.com/nfrerebeau/tabula/) and [rtefact](github.com/ahb108/rtefact)).
29+
2930

3031
Installation
3132
-------
32-
'datplot' can be installed from GitHub directly with devtools:
33+
'datplot' is not currently on CRAN. It can be installed from GitHub with devtools:
3334

3435
devtools::install_github("lsteinmann/datplot")
3536

36-
Recommendation
37-
-------
38-
People interested in employing this method should also consider taking a look at [ISAAKiel's package aoristAAR](https://github.com/ISAAKiel/aoristAAR/).
37+
Or via downloading the latest release and installing from the file:
38+
39+
install_local(path = "../datplot_0.2.4.tar.gz")
3940

4041
Contact
4142
-------

vignettes/data_preparation.Rmd

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -394,20 +394,13 @@ summary(inscr_clean)
394394

395395
# datplot
396396

397-
We can now begin using the **datplot**-package. Since `datplot` is not on CRAN, it is necessary to either install it from our github repository directly or download the source file and install it. For this, R needs the `devtools`-package to be installed.
397+
We can now begin using the **datplot**-package...
398398

399399
```{r eval = FALSE}
400-
library(devtools)
401-
# either
402-
install_github("lsteinmann/datplot") # (redacted)
403-
# or
404-
install_local(path = "../datplot_x.x.x.tar.gz")
400+
library(datplot)
405401
```
406402

407-
408-
# The Output of `datsteps()`
409-
410-
Now we can actually try to use `datsteps()`, first with a `stepsize` of 25 years[^3]:
403+
...and can actually try to use `datsteps()`, first with a `stepsize` of 25 years[^3]:
411404

412405
```{r warning=TRUE, out.lines = 13}
413406
inscr_steps <- inscr_clean %>%

0 commit comments

Comments
 (0)