diff --git a/.Rbuildignore b/.Rbuildignore index 314e13a..6cf7893 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -26,3 +26,6 @@ examples_x64 ^\.github$ ^doc$ ^Meta$ + +vignettes.awk +_pkgdown.yml \ No newline at end of file diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..ed7650c --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,48 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write + steps: + - uses: actions/checkout@v3 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.4.1 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index 76e0c6b..f4ba85e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: dtwSat Type: Package Title: Time-Weighted Dynamic Time Warping for Satellite Image Time Series Analysis Version: 1.0.0 -Date: 2023-09-20 +Date: 2023-09-21 Authors@R: c(person(given = "Victor", family = "Maus", diff --git a/README.md b/README.md index a4f1117..031f02c 100644 --- a/README.md +++ b/README.md @@ -12,31 +12,37 @@ +Provides a robust approach to land use mapping using multi-dimensional +(multi-band) satellite image time series. By leveraging the Time-Weighted Dynamic +Time Warping (TWDTW) distance metric in tandem with a 1 Nearest-Neighbor (1-NN) Classifier, +this package offers functions to produce land use maps based on distinct seasonality patterns, +commonly observed in the phenological cycles of vegetation. The approach is described in +Maus et al. (2016) and Maus et al. (2019). +A primary advantage of TWDTW is its capability to handle irregularly sampled and noisy time series, +while also requiring minimal training sets. The package includes tools for training the 1-NN-TWDTW model, +visualizing temporal patterns, producing land use maps, and visualizing the results. -### Time-Weighted Dynamic Time Warping for satellite image time series analysis +## Getting Started -The package *dtwSat* provides an implementation of the Time-Weighted -Dynamic Time Warping (TWDTW) method for land cover mapping using -multi-band satellite image time series (Maus et al. 2016, 2019). -*dtwSat* provides full cycle of land cover classification using image -time series, ranging from selecting temporal patterns to visualizing, -and assessing the results. - -## Installing - -Install either from CRAN +You can install dtwSat from CRAN using the following command: ``` r install.packages("dtwSat") ``` -or install the development versions from GitHub +Alternatively, you can install the development version from GitHub: ``` r -library(devtools) devtools::install_github("vwmaus/dtwSat") ``` +After installation, you can read the vignette for a quick start guide: + +``` r +vignette("landuse-mapping", "dtwSat") +``` + + ## References